Struct ObjectPath 

pub struct ObjectPath(/* private fields */);

One validated encrypted-object path in the layout of §§5, 10, 12, 13, 16 and 17.

Implementations

impl ObjectPath

pub fn slot(store: StoreId, number: NonZeroU64) -> Self

One create-once slot in the store’s shared sequence (§5).

pub fn slot_number(&self) -> Option<Slot>

The positive number of a sequence slot.

pub fn floor(store: StoreId) -> Self

The store’s conditionally replaced floor (§16.4).

pub fn snapshot_id(&self) -> Option<SnapshotId>

The identity carried by a snapshot path.

pub fn snapshot( store: StoreId, audience: Audience, device: DeviceId, number: NonZeroU64, ) -> Self

A snapshot written by a device (§16).

pub fn file(store: StoreId, device: DeviceId, object: ObjectId) -> Self

A stored object: encrypted file bytes named by a random id (§17.5).

pub fn join_request( store: StoreId, inviting: DeviceId, invite: InviteId, ) -> Self

An encrypted join request under the device that made its invite and the invite’s id (§13.2).

pub fn device_gone(store: StoreId, device: DeviceId) -> Self

The marker of a device gone for good, beside the join requests to its invites (§13.2).

pub fn join_request_invite(&self) -> Option<InviteId>

The invite named by a join request’s path.

pub fn parse(value: &str) -> Result<Self, PathError>

Parse a listed or recorded path without permitting traversal or other layouts.

pub fn store(&self) -> StoreId

The store whose objects this path names.

pub fn as_str(&self) -> &str

The path bound into the object’s encryption by the caller.

pub fn is_replaceable(&self) -> bool

Only the floor can be replaced (D10).

pub fn device(&self) -> Option<DeviceId>

The device named by a snapshot or uploaded file path.

pub fn object_id(&self) -> Option<ObjectId>

The stored object’s id, the last part of a stored file’s path.

pub fn components(&self) -> Vec<&str>

The canonical path components, for providers with folder objects.

pub fn file_name(&self) -> &str

The last path component.

pub fn absolute(&self) -> String

The provider path with a leading slash.

Trait Implementations

impl Clone for ObjectPath

fn clone(&self) -> ObjectPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObjectPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ObjectPath> for String

fn from(path: ObjectPath) -> Self

Converts to this type from the input type.

impl Hash for ObjectPath

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 ObjectPath

fn cmp(&self, other: &ObjectPath) -> 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.

impl PartialEq for ObjectPath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ObjectPath

fn partial_cmp(&self, other: &ObjectPath) -> 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 Serialize for ObjectPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for ObjectPath

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ObjectPath

impl StructuralPartialEq for ObjectPath