Skip to main content

ArtifactReceipt

Struct ArtifactReceipt 

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

The framework’s record of a completed artifact write.

A receipt only exists once the write succeeded, so its destination is a fact, not an intention. It is serialized into the report envelope under receipt as:

{ "destination": "/tmp/export.csv", "stdout": false, "byte_count": 20 }

Implementations§

Source§

impl ArtifactReceipt

Source

pub fn new(destination: ArtifactDestination, byte_count: usize) -> Self

Records a completed write of byte_count bytes to destination.

Framework-owned: applications receive receipts, they do not mint them.

Source

pub fn destination(&self) -> &ArtifactDestination

Returns the destination the write completed to.

Source

pub fn path(&self) -> Option<&Path>

Returns the written file’s path, or None if the bytes went to stdout.

Source

pub fn is_stdout(&self) -> bool

Returns true if the bytes went to standard output.

Source

pub fn byte_count(&self) -> usize

Returns the number of artifact bytes the write covered.

Trait Implementations§

Source§

impl Clone for ArtifactReceipt

Source§

fn clone(&self) -> ArtifactReceipt

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 ArtifactReceipt

Source§

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

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

impl Eq for ArtifactReceipt

Source§

impl PartialEq for ArtifactReceipt

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for ArtifactReceipt

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ArtifactReceipt

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.