Skip to main content

Crate rustfs_storage_api

Crate rustfs_storage_api 

Source
Expand description

Storage API contracts for RustFS.

Re-exports§

pub use admin::DiskSetSelector;
pub use admin::StorageAdminApi;
pub use bucket::BUCKET_LIFECYCLE_LOCK_OBJECT;
pub use bucket::BucketInfo;
pub use bucket::BucketOperations;
pub use bucket::BucketOptions;
pub use bucket::DeleteBucketOptions;
pub use bucket::MakeBucketOptions;
pub use bucket::SRBucketDeleteOp;
pub use capability::CapabilitySnapshotError;
pub use capability::CapabilityState;
pub use capability::CapabilityStatus;
pub use error::StorageErrorCode;
pub use error::StorageResult;
pub use multipart::CompletePart;
pub use multipart::ListMultipartsInfo;
pub use multipart::ListPartsInfo;
pub use multipart::MultipartInfo;
pub use multipart::MultipartUploadResult;
pub use multipart::PartInfo;
pub use object::DeleteAccounting;
pub use object::ObjectLockDeleteOptions;
pub use object::ObjectToDeleteIdentity;
pub use object::DeletedObject;
pub use object::ObjectToDelete;
pub use object::ExpirationOptions;
pub use object::TransitionedObject;
pub use object::HTTPPreconditions;
pub use object::HTTPRangeError;
pub use object::HTTPRangeSpec;
pub use object::ObjectLockRetentionOptions;
pub use object::HealOperations;
pub use object::MultipartOperations;
pub use object::NamespaceLocking;
pub use object::ObjectIO;
pub use object::ObjectOperations;
pub use object::ListObjectVersionsInfo;
pub use object::ListObjectsInfo;
pub use object::ListObjectsV2Info;
pub use object::ListOperations;
pub use object::ObjectInfoOrErr;
pub use object::ObjectPreconditionError;
pub use object::ObjectPreconditionPart;
pub use object::ObjectPreconditionState;
pub use object::VersionMarker;
pub use object::WalkOptions;
pub use object::WalkVersionsSortOrder;
pub use observability::MemorySamplingState;
pub use observability::ObservabilitySnapshot;
pub use observability::ObservabilitySnapshotProvider;
pub use observability::PlatformSupport;
pub use observability::UserspaceProfilingCapability;
pub use topology::DiskCapabilities;
pub use topology::TopologyCapabilities;
pub use topology::TopologyDisk;
pub use topology::TopologyLabels;
pub use topology::TopologyPool;
pub use topology::TopologySet;
pub use topology::TopologySnapshot;
pub use topology::TopologySnapshotProvider;

Modules§

admin
bucket
capability
error
Stable storage error contracts shared across storage consumers.
metadata_keys
Object-metadata keys persisted in xl.meta meta_user. filemeta owns the on-disk spelling; contract consumers that read or write persisted object metadata (lifecycle object-lock checks) take the keys from here. Object-metadata map keys persisted inside xl.meta (MetaObject::meta_user).
multipart
object
observability
topology

Structs§

NsScannerCapabilityResponse
PutFileCapabilityResponse

Constants§

NS_SCANNER_BODY_SHA256_QUERY
NS_SCANNER_CAPABILITY_CHALLENGE_QUERY
NS_SCANNER_CYCLE_QUERY
NS_SCANNER_LEADER_EPOCH_QUERY
NS_SCANNER_PROTOCOL_VERSION
NS_SCANNER_PROTOCOL_VERSION_QUERY
NS_SCANNER_REQUEST_ID_QUERY
NS_SCANNER_SERVER_EPOCH_QUERY
NS_SCANNER_SESSION_ID_QUERY
NS_SCANNER_SESSION_SEQUENCE_QUERY
NS_SCANNER_TIER_REGISTRY_GENERATION_QUERY
PUT_FILE_AUTH_QUERY
PUT_FILE_AUTH_TRAILER_DIGEST_LEN
PUT_FILE_AUTH_TRAILER_LEN
PUT_FILE_AUTH_TRAILER_MAC_LEN
PUT_FILE_AUTH_TRAILER_MAGIC
PUT_FILE_AUTH_V1
PUT_FILE_CAPABILITY_CHALLENGE_QUERY
PUT_FILE_CAPABILITY_QUERY
PUT_FILE_CAPABILITY_VERSION
PUT_FILE_NONCE_QUERY
PUT_FILE_SERVER_EPOCH_QUERY
SCANNER_ACTIVITY_LEGACY_PROTOCOL_VERSION
SCANNER_ACTIVITY_PREVIOUS_PROTOCOL_VERSION
SCANNER_ACTIVITY_PROTOCOL_VERSION
SCANNER_ACTIVITY_V6_PROTOCOL_VERSION
Protocol v6 carries the activity fields that predate the storage-owned movement generation. It remains readable during the rolling upgrade, but a scanner must not use it as a publication proof because terminal movement state is not authenticated by that version.
SCANNER_DIRTY_USAGE_SNAPSHOT_MAX_ENTRIES
SCANNER_DIRTY_USAGE_SNAPSHOT_PROTOCOL_VERSION
SCANNER_DIRTY_USAGE_SNAPSHOT_RPC_MAX_MESSAGE_SIZE
SCANNER_SCOPED_DIRTY_USAGE_ACK_MAX_ENTRIES
WALK_DIR_BODY_SHA256_QUERY
WALK_DIR_STREAM_COMPLETION_QUERY
WALK_DIR_STREAM_COMPLETION_V1