Skip to main content

WriteOutcome

Struct WriteOutcome 

Source
pub struct WriteOutcome { /* private fields */ }
Expand description

Outcome returned when a writer is committed.

§Examples

use qubit_fs::metadata::{AchievedAtomicity, PublicationMethod, WriteOutcome};

let outcome = WriteOutcome::new(AchievedAtomicity::Atomic, PublicationMethod::Direct);
assert_eq!(AchievedAtomicity::Atomic, outcome.atomicity());

Implementations§

Source§

impl WriteOutcome

Source

pub fn new(atomicity: AchievedAtomicity, method: PublicationMethod) -> Self

Creates a write outcome with explicit publication semantics.

§Parameters
  • atomicity: Atomicity actually achieved.
  • method: Method used to publish the resource.
§Returns

A write outcome with no byte count, version, or diagnostics.

Source

pub const fn bytes_written(&self) -> Option<u64>

Returns the number of bytes accepted by the write session, when known.

Source

pub const fn version(&self) -> Option<&ResourceVersion>

Returns the provider version, generation, or ETag when known.

Source

pub const fn atomicity(&self) -> AchievedAtomicity

Returns the atomicity actually achieved by publication.

Source

pub const fn method(&self) -> PublicationMethod

Returns the concrete method that published the resource.

Source

pub const fn durable(&self) -> bool

Returns whether the provider confirmed durable publication.

Source

pub const fn diagnostics(&self) -> &NonSensitiveMetadata

Returns provider-native non-sensitive diagnostics.

Source

pub const fn with_bytes_written(self, bytes_written: u64) -> Self

Records the byte count confirmed by the provider.

Source

pub fn with_version(self, version: ResourceVersion) -> Self

Records the provider version, generation, or ETag.

Source

pub const fn with_durable(self, durable: bool) -> Self

Records whether data and namespace publication were durably synchronized.

Source

pub fn with_diagnostics(self, diagnostics: UserMetadata) -> Self

Replaces provider-native diagnostics that have already passed key validation.

Trait Implementations§

Source§

impl Clone for WriteOutcome

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WriteOutcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WriteOutcome

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WriteOutcome

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.