Skip to main content

UnverifiedOutputsBuilder

Struct UnverifiedOutputsBuilder 

Source
pub struct UnverifiedOutputsBuilder(OutputsInner);
Expand description

Builder for making unverified Outputs.

Even when not verifying the output path of a set of outputs, there are still invariants that must be upheld. But rather than checking all of them in one go, it is useful during construction to check each output as they are added and then do a final check when building the Outputs.

§Examples

use nix_compat::derivation::{OutputName, UnverifiedOutputsBuilder};
use nix_compat::store_path::StorePath;

let mut builder = UnverifiedOutputsBuilder::new();
let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
builder.try_insert(OutputName::out(), out_sp, None).unwrap();
let outputs = builder.try_build().unwrap();

Tuple Fields§

§0: OutputsInner

Implementations§

Source§

impl UnverifiedOutputsBuilder

Source

pub const fn new() -> Self

Return an empty UnverifiedOutputsBuilder.

Source

pub fn len(&self) -> usize

Returns the number of outputs

§Examples
use nix_compat::derivation::{OutputName, UnverifiedOutputsBuilder};
use nix_compat::store_path::StorePath;

let mut builder = UnverifiedOutputsBuilder::new();
assert_eq!(builder.len(), 0);

let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
builder.try_insert(OutputName::out(), out_sp, None).unwrap();
assert_eq!(builder.len(), 1);
Source

pub fn is_empty(&self) -> bool

Returns true if there are not outputs defined in this builder.

§Examples
use nix_compat::derivation::{OutputName, UnverifiedOutputsBuilder};
use nix_compat::store_path::StorePath;

let mut builder = UnverifiedOutputsBuilder::new();
assert!(builder.is_empty());

let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
builder.try_insert(OutputName::out(), out_sp, None).unwrap();
assert!(!builder.is_empty());
Source

pub fn is_input_addressed(&self) -> bool

Returns true if this is a set of input addressed outputs.

§Examples
use nix_compat::derivation::{OutputName, UnverifiedOutputsBuilder};
use nix_compat::store_path::StorePath;

let mut a = UnverifiedOutputsBuilder::new();
assert!(!a.is_input_addressed());

let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
a.try_insert(OutputName::out(), out_sp, None).unwrap();
assert!(a.is_input_addressed());

let bin_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyib-has-multi-out-bin".parse().unwrap();
a.try_insert(OutputName::from_static("bin").unwrap(), bin_sp, None).unwrap();
assert!(a.is_input_addressed());

let mut b = UnverifiedOutputsBuilder::new();
let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
b.try_insert(OutputName::out(), out_sp, Some(output_hash)).unwrap();
assert!(!b.is_input_addressed());
Source

pub fn is_single(&self) -> bool

Returns true if this builder contains a single output called “out”

§Examples
use nix_compat::derivation::{OutputName, UnverifiedOutputsBuilder};
use nix_compat::store_path::StorePath;

let mut a = UnverifiedOutputsBuilder::new();
let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
a.try_insert(OutputName::out(), out_sp, None).unwrap();
assert!(a.is_single());

let bin_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyib-has-multi-out-bin".parse().unwrap();
a.try_insert(OutputName::from_static("bin").unwrap(), bin_sp, None).unwrap();
assert!(!a.is_single());

let mut b = UnverifiedOutputsBuilder::new();
let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
b.try_insert(OutputName::out(), out_sp, Some(output_hash)).unwrap();
assert!(b.is_single());
Source

pub fn is_fixed(&self) -> bool

Returns true if this is a set of input addressed outputs.

§Examples
use nix_compat::derivation::{OutputName, UnverifiedOutputsBuilder};
use nix_compat::store_path::StorePath;

let mut a = UnverifiedOutputsBuilder::new();
assert!(!a.is_fixed());

let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
a.try_insert(OutputName::out(), out_sp, None).unwrap();
assert!(!a.is_fixed());

let mut b = UnverifiedOutputsBuilder::new();
let out_sp : StorePath = "2vixb94v0hy2xc6p7mbnxxcyc095yyia-has-multi-out".parse().unwrap();
b.try_insert(OutputName::out(), out_sp, Some(output_hash)).unwrap();
assert!(b.is_fixed());
Source

pub fn contains_key(&self, name: &OutputName) -> bool

Returns true if the outputs contains an output with the specified name.

Source

pub fn get(&self, name: &OutputName) -> Option<&StorePath>

Returns a reference to the StorePath corresponding to the provided name.

Source

pub fn names(&self) -> OutputNames<'_>

Gets an iterator over the names of the outputs, in sorted order.

Source

pub fn into_names(self) -> IntoOutputNames

Consume this builder and return an iterator over the names of the outputs, in sorted order.

Source

pub fn iter(&self) -> Iter<'_>

Gets an iterator over the entries of the outputs, sorted by name.

Source

pub fn store_paths(&self) -> impl Iterator<Item = &StorePath>

Gets an iterator over the StorePath values of the outputs, in order by name.

Source

pub fn try_insert( &mut self, output_name: OutputName, output_path: StorePath, output_hash: Option<OutputHash>, ) -> Result<(), OutputsError>

Try to insert a new output with the provided values and an error if this violates the invariants.

Source

pub fn try_build(self) -> Result<Outputs, OutputsError>

Consume this builder and return the built Outputs or an error if not possible.

Trait Implementations§

Source§

impl Clone for UnverifiedOutputsBuilder

Source§

fn clone(&self) -> UnverifiedOutputsBuilder

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 UnverifiedOutputsBuilder

Source§

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

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

impl Default for UnverifiedOutputsBuilder

Source§

fn default() -> UnverifiedOutputsBuilder

Returns the “default value” for a type. Read more
Source§

impl From<Outputs> for UnverifiedOutputsBuilder

Source§

fn from(value: Outputs) -> Self

Converts to this type from the input type.
Source§

impl<'a> IntoIterator for &'a UnverifiedOutputsBuilder

Source§

type Item = (&'a OutputName, &'a StorePath)

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for UnverifiedOutputsBuilder

Source§

type Item = (OutputName, StorePath)

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for UnverifiedOutputsBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for UnverifiedOutputsBuilder

Source§

impl StructuralPartialEq for UnverifiedOutputsBuilder

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more