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§
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