ARKBuilder

acorn_lib::schema::pid

Struct ARKBuilder 

Source 
pub struct ARKBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> ARKBuilder<S>

Source

pub fn build(self) -> ARK
where S: IsComplete,

Finish building and return the requested object

Source

pub fn assigned_name(self, value: String) -> ARKBuilder<SetAssignedName<S>>
where S::AssignedName: IsUnset,

Optional (Some / Option setters).

The part of the ARK string that your organization is responsible for making unique.

The first 2 or more characters constitue the shoulder of the ARK which must meet the following criteria:

  • Must start with one or more lowercase letters
  • Must end with a digit (non-zero preferred)
  • Must not contain vowels or the letter “l” (ell)
  • Must not contain any / characters (being opaque is part of the shoulder design)
Source

pub fn maybe_assigned_name( self, value: Option<String>, ) -> ARKBuilder<SetAssignedName<S>>
where S::AssignedName: IsUnset,

Optional (Some / Option setters).

The part of the ARK string that your organization is responsible for making unique.

The first 2 or more characters constitue the shoulder of the ARK which must meet the following criteria:

  • Must start with one or more lowercase letters
  • Must end with a digit (non-zero preferred)
  • Must not contain vowels or the letter “l” (ell)
  • Must not contain any / characters (being opaque is part of the shoulder design)
Source

pub fn label(self, value: String) -> ARKBuilder<SetLabel<S>>
where S::Label: IsUnset,

Optional (Some / Option setters). Default: "ark:".to_string().

Prefix for NAAN (e.g., “ark:” or the older, “ark:/”)

Label is mandatory
Source

pub fn maybe_label(self, value: Option<String>) -> ARKBuilder<SetLabel<S>>
where S::Label: IsUnset,

Optional (Some / Option setters). Default: "ark:".to_string().

Prefix for NAAN (e.g., “ark:” or the older, “ark:/”)

Label is mandatory
Source

pub fn name_assigning_authority_number( self, value: String, ) -> ARKBuilder<SetNameAssigningAuthorityNumber<S>>
where S::NameAssigningAuthorityNumber: IsUnset,

Optional (Some / Option setters).

Number (here represented as a string) identifying an organization that creates or assigns identifiers

§Notes
  • Since 2001, every assigned name assigning authority number (NAAN) has consisted of exactly five digits, specifically five beta-numeric digits
  • Any given identifier will have exactly one NAAN but may have more than one NMA (at a time or over time)
  • Similar to registration authority or prefix for DOIs, naming authority for Handles, and namespace identifier for URNs
Source

pub fn maybe_name_assigning_authority_number( self, value: Option<String>, ) -> ARKBuilder<SetNameAssigningAuthorityNumber<S>>
where S::NameAssigningAuthorityNumber: IsUnset,

Optional (Some / Option setters).

Number (here represented as a string) identifying an organization that creates or assigns identifiers

§Notes
  • Since 2001, every assigned name assigning authority number (NAAN) has consisted of exactly five digits, specifically five beta-numeric digits
  • Any given identifier will have exactly one NAAN but may have more than one NMA (at a time or over time)
  • Similar to registration authority or prefix for DOIs, naming authority for Handles, and namespace identifier for URNs
Source

pub fn name_mapping_authority( self, value: String, ) -> ARKBuilder<SetNameMappingAuthority<S>>
where S::NameMappingAuthority: IsUnset,

Optional (Some / Option setters).

String identifying a service that accepts names and returns information about them

§Notes

Any given identifier will have exactly one NAAN but may have more than one NMA (at a time or over time)

Source

pub fn maybe_name_mapping_authority( self, value: Option<String>, ) -> ARKBuilder<SetNameMappingAuthority<S>>
where S::NameMappingAuthority: IsUnset,

Optional (Some / Option setters).

String identifying a service that accepts names and returns information about them

§Notes

Any given identifier will have exactly one NAAN but may have more than one NMA (at a time or over time)

Source

pub fn parts(self, value: Vec<String>) -> ARKBuilder<SetParts<S>>
where S::Parts: IsUnset,

Optional (Some / Option setters). Default: Vec::new().

First section of optional “qualifier” part of ARK

Generally serve as sub-namespaces to enabling grouping ARKs

Source

pub fn maybe_parts(self, value: Option<Vec<String>>) -> ARKBuilder<SetParts<S>>
where S::Parts: IsUnset,

Optional (Some / Option setters). Default: Vec::new().

First section of optional “qualifier” part of ARK

Generally serve as sub-namespaces to enabling grouping ARKs

Source

pub fn variants(self, value: Vec<String>) -> ARKBuilder<SetVariants<S>>
where S::Variants: IsUnset,

Optional (Some / Option setters). Default: Vec::new().

Last section of optional “qualifier” part of ARK

Typically is used to identify a specific version of a resource (i.e., “pdf”, “fr”, “v3”, etc.)

Source

pub fn maybe_variants( self, value: Option<Vec<String>>, ) -> ARKBuilder<SetVariants<S>>
where S::Variants: IsUnset,

Optional (Some / Option setters). Default: Vec::new().

Last section of optional “qualifier” part of ARK

Typically is used to identify a specific version of a resource (i.e., “pdf”, “fr”, “v3”, etc.)

Auto Trait Implementations§

§

impl<S> Freeze for ARKBuilder<S>

§

impl<S> RefUnwindSafe for ARKBuilder<S>

§

impl<S> Send for ARKBuilder<S>

§

impl<S> Sync for ARKBuilder<S>

§

impl<S> Unpin for ARKBuilder<S>

§

impl<S> UnwindSafe for ARKBuilder<S>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

§

impl<T> PlanCallbackArgs for T

§

impl<T> PlanCallbackOut for T