internal

Documentation

Index

• Variables
• type ControlResult
• type InfoReport
• type Position
  • func (e Position) MarshalText() ([]byte, error)
  • func (e Position) String() string
  • func (e *Position) UnmarshalText(text []byte) error
• type Presence
  • func (e Presence) MarshalJSON() ([]byte, error)
  • func (e Presence) String() string
  • func (e *Presence) UnmarshalJSON(text []byte) error

Variables

var PositionList = []Position{PositionMiddle, PositionLeft, PositionRight}

PositionList contains all valid positions

Types

type ControlResult

type ControlResult struct {
	Text       string `json:"-"`
	WriteError map[Position]string
	GetError   map[Position]string
	InList     map[Position]Presence
}

ControlResult contains the result of a single character test

type InfoReport

type InfoReport struct {
	Remote               string
	ControlCharacters    *map[string]ControlResult
	MaxFileLength        *int
	CanStream            *bool
	CanWriteUnnormalized *bool
	CanReadUnnormalized  *bool
	CanReadRenormalized  *bool
}

InfoReport is the structure of the JSON output

type Position

type Position int

Position is the placement of the test character in the filename

const (
	PositionMiddle Position = 1 << iota
	PositionLeft
	PositionRight
	PositionNone Position = 0
	PositionAll  Position = PositionRight<<1 - 1
)

Predefined positions

func (Position) MarshalText

func (e Position) MarshalText() ([]byte, error)

MarshalText encodes the position when used as a map key

func (Position) String

func (e Position) String() string

func (*Position) UnmarshalText

func (e *Position) UnmarshalText(text []byte) error

UnmarshalText decodes a position when used as a map key

type Presence

type Presence int

Presence describes the presence of a filename in file listing

const (
	Absent Presence = iota
	Present
	Renamed
	Multiple
)

Possible Presence states

func (Presence) MarshalJSON

func (e Presence) MarshalJSON() ([]byte, error)

MarshalJSON encodes the presence when used as a JSON value

func (Presence) String

func (e Presence) String() string

func (*Presence) UnmarshalJSON

func (e *Presence) UnmarshalJSON(text []byte) error

UnmarshalJSON decodes a presence when used as a JSON value