Skip to main content

FormatStringOptions

Struct FormatStringOptions 

Source
pub struct FormatStringOptions<'a> { /* private fields */ }
Expand description

Builder-style options for FormatString::resolve_with and FormatString::resolve_string_with.

All fields are optional; defaults match the zero-argument shortcuts on FormatString (host-native path format, no library, no path mapping rules, no target type coercion). Chain the with_* methods to override any subset.

let fs = FormatString::new("{{Param.Frame}}").unwrap();
let st = SymbolTable::new();
let target = ExprType::INT;
let opts = FormatStringOptions::new()
    .with_path_format(PathFormat::Posix)
    .with_target_type(&target);
let _ = fs.resolve_with(&st, &opts);

Implementations§

Source§

impl<'a> FormatStringOptions<'a>

Source

pub fn new() -> Self

Construct options with all defaults (equivalent to Default::default()).

Source

pub fn with_library( self, library: impl Into<Option<&'a FunctionLibrary>>, ) -> Self

Use the given function library instead of the default (built-in) one.

Accepts either &FunctionLibrary or Option<&FunctionLibrary>; None means “use the default library”. To enable apply_path_mapping, pass a library obtained from FunctionLibrary::for_profile with HostContext::WithRules on the profile.

Source

pub fn with_path_format(self, fmt: PathFormat) -> Self

Construct path() values in this format (default: host-native).

Source

pub fn with_target_type(self, t: &'a ExprType) -> Self

Coerce the resolved value toward this target type.

Ignored by resolve_string_with.

Trait Implementations§

Source§

impl<'a> Clone for FormatStringOptions<'a>

Source§

fn clone(&self) -> FormatStringOptions<'a>

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<'a> Default for FormatStringOptions<'a>

Source§

fn default() -> Self

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

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> 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
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.