category

Documentation

Index

• func Read(name string) (*[]byte, error)
• func Remove(name string) error
• func Write(category *Category) error
• type Category
  • func Get(name string) *Category
  • func New() *Category
  • func NewCategory(anchor, href, name string, number, position int, ...) *Category
  • func Open(name string) (*Category, error)
  • func Parse(content *[]byte) (*Category, error)
  • func (pointer *Category) SetAnchor(anchor string) *Category
  • func (pointer *Category) SetEmoji(emoji *slice.Slice) *Category
  • func (pointer *Category) SetHref(href string) *Category
  • func (pointer *Category) SetName(name string) *Category
  • func (pointer *Category) SetNumber(number int) *Category
  • func (pointer *Category) SetPosition(position int) *Category
  • func (pointer *Category) SetSubcategories(subcategories *slice.Slice) *Category

Functions

func Read

func Read(name string) (*[]byte, error)

func Remove

func Remove(name string) error

Remove deletes the Category data stored in the dependencies folder.

func Write

func Write(category *Category) error

Write stores and Category pointer to the dependencies folder.

Types

type Category

type Category struct {
	Anchor        string       `json:"anchor"`
	Emoji         *slice.Slice `json:"emoji"`
	Href          string       `json:"href"`
	Name          string       `json:"name"`
	Number        int          `json:"number"`
	Position      int          `json:"position"`
	Subcategories *slice.Slice `json:"subcategories"`
}

Category stores the categorical superset of the emoji data.

func Get

func Get(name string) *Category

Get attempts to open a Category from the emojipedia/categories folder, but panics if an error occurs.

func New

func New() *Category

New instantiates a new empty Category pointer.

func NewCategory

func NewCategory(anchor, href, name string, number, position int, emoji, subcategories *slice.Slice) *Category

NewCategory creates a new Category pointer, requiring all struct features as arguments.

func Open

func Open(name string) (*Category, error)

Open attempts to open a Category from the emojipedia/categories folder.

func Parse

func Parse(content *[]byte) (*Category, error)

func (*Category) SetAnchor

func (pointer *Category) SetAnchor(anchor string) *Category

SetAnchor sets the Category.Anchor property.

func (*Category) SetEmoji

func (pointer *Category) SetEmoji(emoji *slice.Slice) *Category

SetEmoji sets the Category.Emoji property.

func (*Category) SetHref

func (pointer *Category) SetHref(href string) *Category

SetHref sets the Category.Href property.

func (*Category) SetName

func (pointer *Category) SetName(name string) *Category

SetName sets the Category.Name property.

func (*Category) SetNumber

func (pointer *Category) SetNumber(number int) *Category

SetNumber sets the Category.Number property.

func (*Category) SetPosition

func (pointer *Category) SetPosition(position int) *Category

SetPosition sets the Category.Position property.

func (*Category) SetSubcategories

func (pointer *Category) SetSubcategories(subcategories *slice.Slice) *Category

SetSubcategories sets the Category.Subcategories property.