schools

package

v0.0.0-...-8dc1090 Latest Latest Go to latest Published: May 10, 2023 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrUnsupportedOperation = errors.New("schools: unsupported operation")

ErrUnsupportedOperation is returned when an operation is performed on a school that isn't supported.

View Source

var MainRegistry = &Registry{
	[]data.School{},
}

MainRegistry is the main registry of schools

This section is empty.

type ImportStatus int

An ImportStatus describes the status of a user's imported data

const (
	ImportStatusNone   ImportStatus = 0
	ImportStatusOK     ImportStatus = 1
	ImportStatusUpdate ImportStatus = 2
)

The types of ImportStatus.

type Provider struct {
	School data.School
}

A Provider is a generic type that implements all methods of a calendar.Provider except for GetView()

func (p *Provider) ID() string

func (p *Provider) Name() string

type Registry struct {
	// contains filtered or unexported fields
}

Registry is a struct that tracks available schools

func (r *Registry) GetAllSchools() []data.School

GetAllSchools returns a list of all schools in the registry. It should not be directly modified.

func (r *Registry) GetSchoolByEmailDomain(domain string) (data.School, error)

GetSchoolByEmailDomain returns the school associated with the given email domain, or nil if it doesn't exist.

func (r *Registry) GetSchoolByID(id string) (data.School, error)

GetSchoolByID returns the school associated with the given ID, or nil if it doesn't exist.

func (r *Registry) Register(school data.School)

Register registers the given school