Skip to main content

NodeParams

Struct NodeParams 

Source
pub struct NodeParams {
    pub sample_rate: f32,
    pub parameters: HashMap<String, ParamValue>,
}
Expand description

A flexible set of parameters passed to a node constructor.

Uses HashMap<String, ParamValue> so any node type can extract whatever named parameters it supports. This is intentionally open-ended — no fixed schema, no required fields.

See [NodeConstructor] (in rill-graph) for how builder uses this.

Fields§

§sample_rate: f32

Sample rate the node will be initialized with.

§parameters: HashMap<String, ParamValue>

Arbitrary named parameters.

Implementations§

Source§

impl NodeParams

Source

pub fn new(sample_rate: f32) -> NodeParams

Create params with a given sample rate.

Source

pub fn with(self, key: impl Into<String>, value: ParamValue) -> NodeParams

Builder-style: insert a parameter and return self.

Source

pub fn get(&self, key: &str) -> Option<&ParamValue>

Get a parameter by name.

Source

pub fn insert( &mut self, key: impl Into<String>, value: ParamValue, ) -> Option<ParamValue>

Insert or overwrite a parameter.

Source

pub fn remove(&mut self, key: &str) -> Option<ParamValue>

Remove a parameter, returning its value if present.

Source

pub fn contains(&self, key: &str) -> bool

Check whether a parameter exists.

Source

pub fn len(&self) -> usize

Number of stored parameters.

Source

pub fn is_empty(&self) -> bool

True when no parameters have been stored.

Source

pub fn get_f32(&self, key: &str, default: f32) -> f32

Get a float parameter by name, falling back to default.

Source

pub fn get_i32(&self, key: &str, default: i32) -> i32

Get an integer parameter by name.

Source

pub fn get_bool(&self, key: &str, default: bool) -> bool

Get a bool parameter by name.

Trait Implementations§

Source§

impl Clone for NodeParams

Source§

fn clone(&self) -> NodeParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeParams

Source§

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

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

impl Default for NodeParams

Source§

fn default() -> NodeParams

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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
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.
Source§

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

Source§

fn vzip(self) -> V