package
1.0.0-rc.12
Repository: https://github.com/nspcc-dev/neofs-sdk-go.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
DemuxReplicatedObject allows to share same argument between multiple [Client.ReplicateObject] calls for deduplication of network messages.
New creates an instance of Client initialized with the given parameters.
NewResEndpointInfo is a constructor for ResEndpointInfo.
NewResSessionCreate is a constructor for NewResSessionCreate.
NewSignError is a constructor for [SignError].
SyncContainerWithNetwork requests network configuration using passed [NetworkInfoExecutor] and applies/rewrites it to the container.
# Variables
ErrMissingAccount is returned when account/owner is not provided.
ErrMissingAnnouncements is returned when announcements are not provided.
ErrMissingEACLContainer is returned when container info is not provided in eACL table.
ErrMissingRanges is returned when empty ranges list is provided.
ErrMissingResponseField is returned when required field is not exists in NeoFS api response.
ErrMissingServer is returned when server endpoint is empty in parameters.
ErrMissingSigner is returned when signer is not provided.
ErrMissingTrusts is returned when empty slice of trusts is provided.
ErrNonPositiveTimeout is returned when any timeout is below zero in parameters.
ErrNoSession indicates that session wasn't set in some Prm* structure.
ErrNoSessionExplicitly is a special error to show auto-session is disabled.
ErrSign is returned when unable to sign service message.
ErrUnexpectedReadCall is returned when we already got all data but truing to get more.
ErrZeroEpoch is returned when zero epoch is provided.
ErrZeroRangeLength is returned when range parameter has zero length.
# Structs
Client represents virtual connection to the NeoFS network to communicate with NeoFS server using NeoFS API protocol.
DefaultObjectWriter implements [ObjectWriter].
MissingResponseFieldErr contains field name which should be in NeoFS API response.
ObjectListReader is designed to read list of object identifiers from NeoFS system.
ObjectRangeReader is designed to read payload range of one object from NeoFS system.
PayloadReader is a data stream of the particular NeoFS object.
PrmAnnounceIntermediateTrust groups optional parameters of AnnounceIntermediateTrust operation.
PrmAnnounceLocalTrust groups optional parameters of AnnounceLocalTrust operation.
PrmAnnounceSpace groups optional parameters of ContainerAnnounceUsedSpace operation.
PrmBalanceGet groups parameters of BalanceGet operation.
PrmContainerDelete groups optional parameters of ContainerDelete operation.
PrmContainerEACL groups optional parameters of ContainerEACL operation.
PrmContainerGet groups optional parameters of ContainerGet operation.
PrmContainerList groups optional parameters of ContainerList operation.
PrmContainerPut groups optional parameters of ContainerPut operation.
PrmContainerSetEACL groups optional parameters of ContainerSetEACL operation.
PrmDial groups connection parameters for the Client.
PrmEndpointInfo groups parameters of EndpointInfo operation.
PrmInit groups initialization parameters of Client instances.
PrmNetMapSnapshot groups parameters of NetMapSnapshot operation.
PrmNetworkInfo groups parameters of NetworkInfo operation.
PrmObjectDelete groups optional parameters of ObjectDelete operation.
PrmObjectGet groups optional parameters of ObjectGetInit operation.
PrmObjectHash groups parameters of ObjectHash operation.
PrmObjectHead groups optional parameters of ObjectHead operation.
PrmObjectPutInit groups parameters of ObjectPutInit operation.
PrmObjectRange groups optional parameters of ObjectRange operation.
PrmObjectSearch groups optional parameters of ObjectSearch operation.
PrmSessionCreate groups parameters of SessionCreate operation.
ResEndpointInfo group resulting values of EndpointInfo operation.
ResObjectPut groups the final result values of ObjectPutInit operation.
ResponseMetaInfo groups meta information about any NeoFS API response.
ResSessionCreate groups resulting values of SessionCreate operation.
SignError wraps another error with reason why sign process was failed.
# Interfaces
NetworkInfoExecutor describes methods to get network information.
ObjectWriter is designed to write one object to NeoFS system.