Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

schwift

package module

Go to main page

Versions in this module

v1

v1.3.0

Oct 25, 2023

Changes in this version

type UnexpectedStatusCodeError

+ Method string

+ Target string

v1.2.0

Oct 28, 2022

v1.1.0

Feb 7, 2022

v1.0.0

May 28, 2021

Changes in this version

+ const DefaultUserAgent

+ const Version

+ var ErrAccountMismatch = errors.New("some of the given objects are not in this account")

+ var ErrChecksumMismatch = errors.New("Etag on uploaded object does not match MD5 checksum of uploaded data")

+ var ErrContainerMismatch = errors.New("some of the given objects are not in this container")

+ var ErrMalformedContainerName = errors.New("container name may not contain slashes")

+ var ErrNoContainerName = errors.New("missing container name")

+ var ErrNotLarge = errors.New("not a large object")

+ var ErrNotSupported = errors.New("operation not supported by this Swift server")

+ var ErrSegmentInvalid = errors.New("segment invalid or incompatible with large object strategy")

+ func Is(err error, code int) bool

+ type Account struct

+ func InitializeAccount(backend Backend) (*Account, error)

+ func (a *Account) Backend() Backend

+ func (a *Account) BulkDelete(objects []*Object, containers []*Container, opts *RequestOptions) (numDeleted int, numNotFound int, deleteError error)

+ func (a *Account) BulkUpload(uploadPath string, format BulkUploadFormat, contents io.Reader, ...) (int, error)

+ func (a *Account) Capabilities() (Capabilities, error)

+ func (a *Account) Container(name string) *Container

+ func (a *Account) Containers() *ContainerIterator

+ func (a *Account) Create(opts *RequestOptions) error

+ func (a *Account) Headers() (AccountHeaders, error)

+ func (a *Account) Invalidate()

+ func (a *Account) IsEqualTo(other *Account) bool

+ func (a *Account) Name() string

+ func (a *Account) RawCapabilities() ([]byte, error)

+ func (a *Account) SwitchAccount(accountName string) *Account

+ func (a *Account) Update(headers AccountHeaders, opts *RequestOptions) error

+ type AccountHeaders struct

+ func NewAccountHeaders() AccountHeaders

+ func (h AccountHeaders) BytesUsed() FieldUint64Readonly

+ func (h AccountHeaders) BytesUsedQuota() FieldUint64

+ func (h AccountHeaders) ContainerCount() FieldUint64Readonly

+ func (h AccountHeaders) CreatedAt() FieldUnixTimeReadonly

+ func (h AccountHeaders) Metadata() FieldMetadata

+ func (h AccountHeaders) ObjectCount() FieldUint64Readonly

+ func (h AccountHeaders) TempURLKey() FieldString

+ func (h AccountHeaders) TempURLKey2() FieldString

+ func (h AccountHeaders) Validate() error

+ type Backend interface

+ Clone func(newEndpointURL string) Backend

+ Do func(req *http.Request) (*http.Response, error)

+ EndpointURL func() string

+ type BulkError struct

+ ObjectErrors []BulkObjectError

+ OverallError string

+ StatusCode int

+ func (e BulkError) Error() string

+ type BulkObjectError struct

+ ContainerName string

+ ObjectName string

+ StatusCode int

+ func (e BulkObjectError) Error() string

+ type BulkUploadFormat string

+ const BulkUploadTar

+ const BulkUploadTarBzip2

+ const BulkUploadTarGzip

+ type Capabilities struct

+ BulkDelete ...

+ BulkUpload ...

+ StaticLargeObject ...

+ Swift struct{ ... }

+ Swift3 ...

+ Symlink ...

+ TempAuth ...

+ TempURL ...

+ type Container struct

+ func (c *Container) Account() *Account

+ func (c *Container) Create(opts *RequestOptions) error

+ func (c *Container) Delete(opts *RequestOptions) error

+ func (c *Container) EnsureExists() (*Container, error)

+ func (c *Container) Exists() (bool, error)

+ func (c *Container) Headers() (ContainerHeaders, error)

+ func (c *Container) Invalidate()

+ func (c *Container) IsEqualTo(other *Container) bool

+ func (c *Container) Name() string

+ func (c *Container) Object(name string) *Object

+ func (c *Container) Objects() *ObjectIterator

+ func (c *Container) URL() (string, error)

+ func (c *Container) Update(headers ContainerHeaders, opts *RequestOptions) error

+ type ContainerHeaders struct

+ func NewContainerHeaders() ContainerHeaders

+ func (h ContainerHeaders) BytesUsed() FieldUint64Readonly

+ func (h ContainerHeaders) BytesUsedQuota() FieldUint64

+ func (h ContainerHeaders) CreatedAt() FieldUnixTimeReadonly

+ func (h ContainerHeaders) HistoryLocation() FieldString

+ func (h ContainerHeaders) Metadata() FieldMetadata

+ func (h ContainerHeaders) ObjectCount() FieldUint64Readonly

+ func (h ContainerHeaders) ObjectCountQuota() FieldUint64

+ func (h ContainerHeaders) ReadACL() FieldString

+ func (h ContainerHeaders) StoragePolicy() FieldString

+ func (h ContainerHeaders) SyncKey() FieldString

+ func (h ContainerHeaders) SyncTo() FieldString

+ func (h ContainerHeaders) TempURLKey() FieldString

+ func (h ContainerHeaders) TempURLKey2() FieldString

+ func (h ContainerHeaders) Validate() error

+ func (h ContainerHeaders) VersionsLocation() FieldString

+ func (h ContainerHeaders) WriteACL() FieldString

+ type ContainerInfo struct

+ BytesUsed uint64

+ Container *Container

+ LastModified time.Time

+ ObjectCount uint64

+ type ContainerIterator struct

+ Account *Account

+ Options *RequestOptions

+ Prefix string

+ func (i *ContainerIterator) Collect() ([]*Container, error)

+ func (i *ContainerIterator) CollectDetailed() ([]ContainerInfo, error)

+ func (i *ContainerIterator) Foreach(callback func(*Container) error) error

+ func (i *ContainerIterator) ForeachDetailed(callback func(ContainerInfo) error) error

+ func (i *ContainerIterator) NextPage(limit int) ([]*Container, error)

+ func (i *ContainerIterator) NextPageDetailed(limit int) ([]ContainerInfo, error)

+ type CopyOptions struct

+ FreshMetadata bool

+ ShallowCopySymlinks bool

+ type DeleteOptions struct

+ DeleteSegments bool

+ type DownloadedObject struct

+ func (o DownloadedObject) AsByteSlice() ([]byte, error)

+ func (o DownloadedObject) AsReadCloser() (io.ReadCloser, error)

+ func (o DownloadedObject) AsString() (string, error)

+ type FieldHTTPTimeReadonly struct

+ func (f FieldHTTPTimeReadonly) Exists() bool

+ func (f FieldHTTPTimeReadonly) Get() time.Time

+ type FieldMetadata struct

+ func (m FieldMetadata) Clear(key string)

+ func (m FieldMetadata) Del(key string)

+ func (m FieldMetadata) Get(key string) string

+ func (m FieldMetadata) Set(key, value string)

+ type FieldString struct

+ func (f FieldString) Clear()

+ func (f FieldString) Del()

+ func (f FieldString) Exists() bool

+ func (f FieldString) Get() string

+ func (f FieldString) Set(value string)

+ type FieldUint64 struct

+ func (f FieldUint64) Clear()

+ func (f FieldUint64) Del()

+ func (f FieldUint64) Exists() bool

+ func (f FieldUint64) Get() uint64

+ func (f FieldUint64) Set(value uint64)

+ type FieldUint64Readonly struct

+ func (f FieldUint64Readonly) Exists() bool

+ func (f FieldUint64Readonly) Get() uint64

+ type FieldUnixTime struct

+ func (f FieldUnixTime) Clear()

+ func (f FieldUnixTime) Del()

+ func (f FieldUnixTime) Exists() bool

+ func (f FieldUnixTime) Get() time.Time

+ func (f FieldUnixTime) Set(value time.Time)

+ type FieldUnixTimeReadonly struct

+ func (f FieldUnixTimeReadonly) Exists() bool

+ func (f FieldUnixTimeReadonly) Get() time.Time

+ type Headers map[string]string

+ func (h Headers) Clear(key string)

+ func (h Headers) Del(key string)

+ func (h Headers) Get(key string) string

+ func (h Headers) Set(key, value string)

+ func (h Headers) ToHTTP() http.Header

+ func (h Headers) ToOpts() *RequestOptions

+ type LargeObject struct

+ func (lo *LargeObject) AddSegment(segment SegmentInfo) error

+ func (lo *LargeObject) Append(contents io.Reader, segmentSizeBytes int64, opts *RequestOptions) error

+ func (lo *LargeObject) NextSegmentObject() *Object

+ func (lo *LargeObject) Object() *Object

+ func (lo *LargeObject) SegmentContainer() *Container

+ func (lo *LargeObject) SegmentObjects() []*Object

+ func (lo *LargeObject) SegmentPrefix() string

+ func (lo *LargeObject) Segments() ([]SegmentInfo, error)

+ func (lo *LargeObject) Strategy() LargeObjectStrategy

+ func (lo *LargeObject) Truncate(opts *TruncateOptions) error

+ func (lo *LargeObject) WriteManifest(opts *RequestOptions) error

+ type LargeObjectStrategy int

+ const DynamicLargeObject

+ const StaticLargeObject

+ type MalformedHeaderError struct

+ Key string

+ ParseError error

+ func (e MalformedHeaderError) Error() string

+ type Object struct

+ func (o *Object) AsLargeObject() (*LargeObject, error)

+ func (o *Object) AsNewLargeObject(sopts SegmentingOptions, topts *TruncateOptions) (*LargeObject, error)

+ func (o *Object) Container() *Container

+ func (o *Object) CopyTo(target *Object, opts *CopyOptions, ropts *RequestOptions) error

+ func (o *Object) Delete(opts *DeleteOptions, ropts *RequestOptions) error

+ func (o *Object) Download(opts *RequestOptions) DownloadedObject

+ func (o *Object) Exists() (bool, error)

+ func (o *Object) FullName() string

+ func (o *Object) Headers() (ObjectHeaders, error)

+ func (o *Object) Invalidate()

+ func (o *Object) IsEqualTo(other *Object) bool

+ func (o *Object) Name() string

+ func (o *Object) SymlinkHeaders() (headers ObjectHeaders, target *Object, err error)

+ func (o *Object) SymlinkTo(target *Object, opts *SymlinkOptions, ropts *RequestOptions) error

+ func (o *Object) TempURL(key, method string, expires time.Time) (string, error)

+ func (o *Object) URL() (string, error)

+ func (o *Object) Update(headers ObjectHeaders, opts *RequestOptions) error

+ func (o *Object) Upload(content io.Reader, opts *UploadOptions, ropts *RequestOptions) error

+ func (o *Object) UploadFromWriter(opts *UploadOptions, ropts *RequestOptions, callback func(io.Writer) error) error

+ type ObjectHeaders struct

+ func NewObjectHeaders() ObjectHeaders

+ func (h ObjectHeaders) ContentDisposition() FieldString

+ func (h ObjectHeaders) ContentEncoding() FieldString

+ func (h ObjectHeaders) ContentType() FieldString

+ func (h ObjectHeaders) CreatedAt() FieldUnixTimeReadonly

+ func (h ObjectHeaders) Etag() FieldString

+ func (h ObjectHeaders) ExpiresAt() FieldUnixTime

+ func (h ObjectHeaders) IsDynamicLargeObject() bool

+ func (h ObjectHeaders) IsLargeObject() bool

+ func (h ObjectHeaders) IsStaticLargeObject() bool

+ func (h ObjectHeaders) Metadata() FieldMetadata

+ func (h ObjectHeaders) SizeBytes() FieldUint64

+ func (h ObjectHeaders) SymlinkTarget() FieldString

+ func (h ObjectHeaders) SymlinkTargetAccount() FieldString

+ func (h ObjectHeaders) UpdatedAt() FieldHTTPTimeReadonly

+ func (h ObjectHeaders) Validate() error

+ type ObjectInfo struct

+ ContentType string

+ Etag string

+ LastModified time.Time

+ Object *Object

+ SizeBytes uint64

+ SubDirectory string

+ SymlinkTarget *Object

+ type ObjectIterator struct

+ Container *Container

+ Delimiter string

+ Options *RequestOptions

+ Prefix string

+ func (i *ObjectIterator) Collect() ([]*Object, error)

+ func (i *ObjectIterator) CollectDetailed() ([]ObjectInfo, error)

+ func (i *ObjectIterator) Foreach(callback func(*Object) error) error

+ func (i *ObjectIterator) ForeachDetailed(callback func(ObjectInfo) error) error

+ func (i *ObjectIterator) NextPage(limit int) ([]*Object, error)

+ func (i *ObjectIterator) NextPageDetailed(limit int) ([]ObjectInfo, error)

+ type Request struct

+ Body io.Reader

+ ContainerName string

+ DrainResponseBody bool

+ ExpectStatusCodes []int

+ Method string

+ ObjectName string

+ Options *RequestOptions

+ func (r Request) Do(backend Backend) (*http.Response, error)

+ func (r Request) URL(backend Backend, values url.Values) (string, error)

+ type RequestOptions struct

+ Context context.Context

+ Headers Headers

+ Values url.Values

+ type SegmentInfo struct

+ Data []byte

+ Etag string

+ Object *Object

+ RangeLength uint64

+ RangeOffset int64

+ SizeBytes uint64

+ type SegmentingOptions struct

+ SegmentContainer *Container

+ SegmentPrefix string

+ Strategy LargeObjectStrategy

+ type StoragePolicySpec struct

+ Aliases string

+ Default bool

+ Name string

+ type SymlinkOptions struct

+ DeleteSegments bool

+ type TruncateOptions struct

+ DeleteSegments bool

+ type UnexpectedStatusCodeError struct

+ ActualResponse *http.Response

+ ExpectedStatusCodes []int

+ ResponseBody []byte

+ func (e UnexpectedStatusCodeError) Error() string

+ type UploadOptions struct

+ DeleteSegments bool