Struct BlobKey 

pub struct BlobKey { /* private fields */ }

A blob’s content hash and storage namespace. Pack RPCs construct only Pack keys, so an upload marker cannot be fetched as a pack.

Implementations

impl BlobKey

pub const fn pack(hash: Hash) -> Self

Construct a pack key.

pub const fn upload_marker(hash: Hash) -> Self

Construct an upload marker key.

pub const fn object(id: Hash) -> Self

Construct a global object key: the extracted content of object id.

pub const fn object_offsets(manifest_id: Hash) -> Self

Construct an offsets sidecar key for the ChunkedBlob manifest_id.

pub fn expected_root(&self, root: Option<Hash>) -> Result<Hash, StoreError>

The hash a sink verifies the bytes against: the key’s own hash for root = None (pack and marker keys), or the caller’s content root for an object key, whose hash is an object id rather than a content hash. An object key without a root, and a root on any other key, are refused, so no backend can publish bytes under an object id without checking them.

Errors

StoreError::Invalid for either mismatch.

pub const fn hash(&self) -> &Hash

Content hash bytes.

pub fn to_hex(&self) -> String

Lowercase hexadecimal content hash.

pub fn relative_path(&self, pack_keyspace: &str) -> Result<String, StoreError>

Path relative to a blob root, given the pack keyspace (which may include a deployment prefix). Markers and objects use its sibling namespaces.

Errors

StoreError::Invalid for a namespace this backend does not support.

pub const fn namespace(&self) -> BlobNamespace

Physical namespace.

Trait Implementations

impl Clone for BlobKey

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BlobKey

impl Debug for BlobKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BlobKey

impl From<PackKey> for BlobKey

fn from(key: PackKey) -> Self

Converts to this type from the input type.

impl Hash for BlobKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BlobKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for BlobKey

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for BlobKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BlobKey