tags

Documentation

Index

• type Error
• type Tag
  • func (tag Tag) IsEmpty() bool
  • func (tag Tag) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (tag Tag) String() string
  • func (tag *Tag) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
  • func (tag Tag) Validate() error
• type Tags
  • func MapToBucketTags(tagMap map[string]string) (*Tags, error)
  • func MapToObjectTags(tagMap map[string]string) (*Tags, error)
  • func NewTags(tagMap map[string]string, isObject bool) (*Tags, error)
  • func Parse(s string, isObject bool) (*Tags, error)
  • func ParseBucketXML(reader io.Reader) (*Tags, error)
  • func ParseObjectTags(s string) (*Tags, error)
  • func ParseObjectXML(reader io.Reader) (*Tags, error)
  • func (tags Tags) Count() int
  • func (tags *Tags) Remove(key string)
  • func (tags *Tags) Set(key, value string) error
  • func (tags Tags) String() string
  • func (tags Tags) ToMap() map[string]string

Types

type Error

type Error interface {
	error
	Code() string
}

Error contains tag specific error.

type Tag

type Tag struct {
	Key   string `xml:"Key"`
	Value string `xml:"Value"`
}

Tag denotes key and value.

func (Tag) IsEmpty

func (tag Tag) IsEmpty() bool

IsEmpty returns whether this tag is empty or not.

func (Tag) MarshalXML

func (tag Tag) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML encodes to XML data.

func (Tag) String

func (tag Tag) String() string

func (*Tag) UnmarshalXML

func (tag *Tag) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML decodes XML data to tag.

func (Tag) Validate

func (tag Tag) Validate() error

Validate checks this tag.

type Tags

type Tags tagging

Tags is list of tags of XML request/response as per https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html#API_GetBucketTagging_RequestBody

func MapToBucketTags

func MapToBucketTags(tagMap map[string]string) (*Tags, error)

MapToBucketTags converts an input map of key and value into *Tags data structure with validation.

func MapToObjectTags

func MapToObjectTags(tagMap map[string]string) (*Tags, error)

MapToObjectTags converts an input map of key and value into *Tags data structure with validation.

func NewTags

func NewTags(tagMap map[string]string, isObject bool) (*Tags, error)

NewTags creates Tags from tagMap, If isObject is set, it validates for object tags.

func Parse

func Parse(s string, isObject bool) (*Tags, error)

Parse decodes HTTP query formatted string into tags which is limited by isObject. A query formatted string is like "key1=value1&key2=value2".

func ParseBucketXML

func ParseBucketXML(reader io.Reader) (*Tags, error)

ParseBucketXML decodes XML data of tags in reader specified in https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html#API_PutBucketTagging_RequestSyntax.

func ParseObjectTags

func ParseObjectTags(s string) (*Tags, error)

ParseObjectTags decodes HTTP query formatted string into tags. A query formatted string is like "key1=value1&key2=value2".

func ParseObjectXML

func ParseObjectXML(reader io.Reader) (*Tags, error)

ParseObjectXML decodes XML data of tags in reader specified in https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html#API_PutObjectTagging_RequestSyntax

func (Tags) Count

func (tags Tags) Count() int

Count - return number of tags accounted for

func (*Tags) Remove

func (tags *Tags) Remove(key string)

Remove removes a tag by its key.

func (*Tags) Set

func (tags *Tags) Set(key, value string) error

Set sets new tag.

func (Tags) String

func (tags Tags) String() string

func (Tags) ToMap

func (tags Tags) ToMap() map[string]string

ToMap returns copy of tags.