Documentation
¶
Overview ¶
Package paths implements wrappers for handling encrypted and unencrypted paths safely.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Encrypted ¶
type Encrypted struct {
// contains filtered or unexported fields
}
Encrypted is an opaque type representing an encrypted path.
func NewEncrypted ¶
NewEncrypted takes a raw encrypted path and returns it wrapped.
func (Encrypted) Consume ¶
Consume attempts to remove the prefix from the Encrypted path and reports a boolean indicating if it was able to do so.
type Iterator ¶
type Iterator struct {
// contains filtered or unexported fields
}
Iterator allows one to efficiently iterate over components of a path.
func NewIterator ¶
NewIterator returns an Iterator for components of the provided raw path.
type Unencrypted ¶
type Unencrypted struct {
// contains filtered or unexported fields
}
Unencrypted is an opaque type representing an unencrypted path.
func NewUnencrypted ¶
func NewUnencrypted(raw string) Unencrypted
NewUnencrypted takes a raw unencrypted path and returns it wrapped.
func (Unencrypted) Consume ¶
func (path Unencrypted) Consume(prefix Unencrypted) (Unencrypted, bool)
Consume attempts to remove the prefix from the Unencrypted path and reports a boolean indicating if it was able to do so.
func (Unencrypted) Iterator ¶
func (path Unencrypted) Iterator() Iterator
Iterator returns an iterator over the components of the Unencrypted.
func (Unencrypted) Less ¶
func (path Unencrypted) Less(other Unencrypted) bool
Less returns true if 'path' should be sorted earlier than 'other'.
func (Unencrypted) Raw ¶
func (path Unencrypted) Raw() string
Raw returns the original raw path for the Unencrypted.
func (Unencrypted) String ¶
func (path Unencrypted) String() string
String returns a human readable form of the Unencrypted.
func (Unencrypted) Valid ¶
func (path Unencrypted) Valid() bool
Valid returns if the unencrypted path is valid, which is the same as not being empty.
Source Files