Trait ParameterServerOps 

pub trait ParameterServerOps<'s>: Sealed + Sized {
    // Required methods
    fn take_truncated_descriptions(
        &mut self,
        report: impl FnMut(NodeKey, &str),
    ) -> usize;
    fn new_in(table: ParameterTable<'s>) -> Self;
    fn set_allow_undeclared(&mut self, node: NodeKey, allow: bool);
    fn allows_undeclared(&self, node: NodeKey) -> bool;
    fn set_parameter_events(&mut self, node: NodeKey, on: bool);
    fn parameter_events_enabled(&self, node: NodeKey) -> bool;
    fn pop_initial_parameter_event(&mut self) -> Option<PendingParameterEvent>;
    fn pop_parameter_event(&mut self) -> Option<PendingParameterEvent>;
    fn take_parameter_events_dropped(&mut self) -> u32;
    fn set_delete_on_not_set(&mut self, node: NodeKey, on: bool);
    fn len(&self, node: NodeKey) -> usize;
    fn is_empty(&self, node: NodeKey) -> bool;
    fn total_len(&self) -> usize;
    fn capacity(&self) -> usize;
    fn is_full(&self) -> bool;
    fn declare(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> bool;
    fn declare_ref(
        &mut self,
        node: NodeKey,
        name: &str,
        value: &ParameterValue,
    ) -> bool;
    fn declare_with_descriptor(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
        descriptor: Option<ParameterDescriptor>,
    ) -> bool;
    fn try_declare(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> Result<(), DeclarationError>;
    fn try_declare_with_descriptor(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
        descriptor: Option<ParameterDescriptor>,
    ) -> Result<(), DeclarationError>;
    fn try_declare_ref(
        &mut self,
        node: NodeKey,
        name: &str,
        value: &ParameterValue,
        descriptor: Option<ParameterDescriptor>,
    ) -> Result<(), DeclarationError>;
    fn check_apply(
        &self,
        node: NodeKey,
        name: &str,
        value: &ParameterValue,
    ) -> Result<(), ParameterError>;
    fn apply(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> Result<(), ParameterError>;
    fn apply_ref(
        &mut self,
        node: NodeKey,
        name: &str,
        value: &ParameterValue,
    ) -> Result<(), ParameterError>;
    fn apply_staged(
        &mut self,
        node: NodeKey,
        name: &str,
        staged: &mut ParameterValue,
    ) -> Result<(), ParameterError>;
    fn set_local(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> Result<(), ParameterError>;
    fn add_on_set_parameters_callback(
        &mut self,
        node: NodeKey,
        callback: OnSetParameterFn,
        ctx: OnSetContext,
    ) -> Option<OnSetParameterHandle>;
    fn remove_on_set_parameters_callback(
        &mut self,
        handle: OnSetParameterHandle,
    ) -> bool;
    fn on_set_callbacks_free(&self) -> usize;
    fn set_parameter_description(
        &mut self,
        node: NodeKey,
        name: &str,
        description: &str,
        additional_constraints: &str,
    ) -> bool;
    fn set_parameter_read_only(
        &mut self,
        node: NodeKey,
        name: &str,
        read_only: bool,
    ) -> bool;
    fn set_parameter_integer_range(
        &mut self,
        node: NodeKey,
        name: &str,
        min: i64,
        max: i64,
        step: i64,
    ) -> bool;
    fn set_parameter_float_range(
        &mut self,
        node: NodeKey,
        name: &str,
        min: f64,
        max: f64,
        step: f64,
    ) -> bool;
    fn apply_atomically<'x, I>(
        &mut self,
        node: NodeKey,
        items: I,
    ) -> Result<(), ParameterError>
       where I: Iterator<Item = Option<(&'x str, ParameterValue)>> + Clone;
    fn apply_atomically_with<'x>(
        &mut self,
        node: NodeKey,
        count: usize,
        fill: impl FnMut(usize, &mut ParameterValue) -> Option<&'x str>,
    ) -> Result<(), ParameterError>;
    fn get(&self, node: NodeKey, name: &str) -> Option<&ParameterValue>;
    fn get_parameter(&self, node: NodeKey, name: &str) -> Option<&Parameter>;
    fn get_descriptor(
        &self,
        node: NodeKey,
        name: &str,
    ) -> Option<&ParameterDescriptor>;
    fn set(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> Result<(), ParameterError>;
    fn set_ref(
        &mut self,
        node: NodeKey,
        name: &str,
        value: &ParameterValue,
    ) -> Result<(), ParameterError>;
    fn unset(&mut self, node: NodeKey, name: &str) -> Result<(), ParameterError>;
    fn set_or_declare(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> Result<(), ParameterError>;
    fn has(&self, node: NodeKey, name: &str) -> bool;
    fn remove(&mut self, node: NodeKey, name: &str) -> bool;
    fn get_type(&self, node: NodeKey, name: &str) -> Option<ParameterType>;
    fn iter(&self, node: NodeKey) -> impl Iterator<Item = &Parameter>;
    fn list_names(&self, node: NodeKey) -> impl Iterator<Item = &str>;
    fn list_with_prefix<'a>(
        &'a self,
        node: NodeKey,
        prefix: &'a str,
    ) -> impl Iterator<Item = &'a str>;
    fn get_bool(&self, node: NodeKey, name: &str) -> Option<bool>;
    fn get_integer(&self, node: NodeKey, name: &str) -> Option<i64>;
    fn get_double(&self, node: NodeKey, name: &str) -> Option<f64>;
    fn get_string(&self, node: NodeKey, name: &str) -> Option<&str>;
    fn set_bool(
        &mut self,
        node: NodeKey,
        name: &str,
        value: bool,
    ) -> Result<(), ParameterError>;
    fn set_integer(
        &mut self,
        node: NodeKey,
        name: &str,
        value: i64,
    ) -> Result<(), ParameterError>;
    fn set_double(
        &mut self,
        node: NodeKey,
        name: &str,
        value: f64,
    ) -> Result<(), ParameterError>;
    fn set_string(
        &mut self,
        node: NodeKey,
        name: &str,
        value: &str,
    ) -> Result<(), ParameterError>;
    fn declare_parameter(
        &mut self,
        node: NodeKey,
        descriptor: ParameterDescriptor,
        initial_value: Option<&ParameterValue>,
    ) -> Result<(), ParameterError>;
    fn get_parameter_value(
        &self,
        node: NodeKey,
        name: &str,
    ) -> Option<ParameterValue>;
    fn set_parameter_value(
        &mut self,
        node: NodeKey,
        name: &str,
        value: ParameterValue,
    ) -> Result<(), ParameterError>;
}

ParameterServer’s operations, for the crates that implement the parameter verbs. Sealed.

Required Methods

fn take_truncated_descriptions( &mut self, report: impl FnMut(NodeKey, &str), ) -> usize

See ParameterServer::take_truncated_descriptions in server.rs.

fn new_in(table: ParameterTable<'s>) -> Self

See ParameterServer::new_in in server.rs.

fn set_allow_undeclared(&mut self, node: NodeKey, allow: bool)

See ParameterServer::set_allow_undeclared in server.rs.

fn allows_undeclared(&self, node: NodeKey) -> bool

See ParameterServer::allows_undeclared in server.rs.

fn set_parameter_events(&mut self, node: NodeKey, on: bool)

See ParameterServer::set_parameter_events in server.rs.

fn parameter_events_enabled(&self, node: NodeKey) -> bool

See ParameterServer::parameter_events_enabled in server.rs.

fn pop_initial_parameter_event(&mut self) -> Option<PendingParameterEvent>

See ParameterServer::pop_initial_parameter_event in server.rs.

fn pop_parameter_event(&mut self) -> Option<PendingParameterEvent>

See ParameterServer::pop_parameter_event in server.rs.

fn take_parameter_events_dropped(&mut self) -> u32

See ParameterServer::take_parameter_events_dropped in server.rs.

fn set_delete_on_not_set(&mut self, node: NodeKey, on: bool)

See ParameterServer::set_delete_on_not_set in server.rs.

fn len(&self, node: NodeKey) -> usize

See ParameterServer::len in server.rs.

fn is_empty(&self, node: NodeKey) -> bool

See ParameterServer::is_empty in server.rs.

fn total_len(&self) -> usize

See ParameterServer::total_len in server.rs.

fn capacity(&self) -> usize

See ParameterServer::capacity in server.rs.

fn is_full(&self) -> bool

See ParameterServer::is_full in server.rs.

fn declare(&mut self, node: NodeKey, name: &str, value: ParameterValue) -> bool

See ParameterServer::declare in server.rs.

fn declare_ref( &mut self, node: NodeKey, name: &str, value: &ParameterValue, ) -> bool

See ParameterServer::declare_ref in server.rs.

fn declare_with_descriptor( &mut self, node: NodeKey, name: &str, value: ParameterValue, descriptor: Option<ParameterDescriptor>, ) -> bool

See ParameterServer::declare_with_descriptor in server.rs.

fn try_declare( &mut self, node: NodeKey, name: &str, value: ParameterValue, ) -> Result<(), DeclarationError>

See ParameterServer::try_declare in server.rs.

fn try_declare_with_descriptor( &mut self, node: NodeKey, name: &str, value: ParameterValue, descriptor: Option<ParameterDescriptor>, ) -> Result<(), DeclarationError>

See ParameterServer::try_declare_with_descriptor in server.rs.

fn try_declare_ref( &mut self, node: NodeKey, name: &str, value: &ParameterValue, descriptor: Option<ParameterDescriptor>, ) -> Result<(), DeclarationError>

See ParameterServer::try_declare_ref in server.rs.

fn check_apply( &self, node: NodeKey, name: &str, value: &ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::check_apply in server.rs.

fn apply( &mut self, node: NodeKey, name: &str, value: ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::apply in server.rs.

fn apply_ref( &mut self, node: NodeKey, name: &str, value: &ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::apply_ref in server.rs.

fn apply_staged( &mut self, node: NodeKey, name: &str, staged: &mut ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::apply_staged in server.rs.

fn set_local( &mut self, node: NodeKey, name: &str, value: ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::set_local in server.rs.

fn add_on_set_parameters_callback( &mut self, node: NodeKey, callback: OnSetParameterFn, ctx: OnSetContext, ) -> Option<OnSetParameterHandle>

See ParameterServer::add_on_set_parameters_callback in server.rs.

fn remove_on_set_parameters_callback( &mut self, handle: OnSetParameterHandle, ) -> bool

See ParameterServer::remove_on_set_parameters_callback in server.rs.

fn on_set_callbacks_free(&self) -> usize

See ParameterServer::on_set_callbacks_free in server.rs.

fn set_parameter_description( &mut self, node: NodeKey, name: &str, description: &str, additional_constraints: &str, ) -> bool

See ParameterServer::set_parameter_description in server.rs.

fn set_parameter_read_only( &mut self, node: NodeKey, name: &str, read_only: bool, ) -> bool

See ParameterServer::set_parameter_read_only in server.rs.

fn set_parameter_integer_range( &mut self, node: NodeKey, name: &str, min: i64, max: i64, step: i64, ) -> bool

See ParameterServer::set_parameter_integer_range in server.rs.

fn set_parameter_float_range( &mut self, node: NodeKey, name: &str, min: f64, max: f64, step: f64, ) -> bool

See ParameterServer::set_parameter_float_range in server.rs.

fn apply_atomically<'x, I>( &mut self, node: NodeKey, items: I, ) -> Result<(), ParameterError>

where I: Iterator<Item = Option<(&'x str, ParameterValue)>> + Clone,

See ParameterServer::apply_atomically in server.rs.

fn apply_atomically_with<'x>( &mut self, node: NodeKey, count: usize, fill: impl FnMut(usize, &mut ParameterValue) -> Option<&'x str>, ) -> Result<(), ParameterError>

See ParameterServer::apply_atomically_with in server.rs.

fn get(&self, node: NodeKey, name: &str) -> Option<&ParameterValue>

See ParameterServer::get in server.rs.

fn get_parameter(&self, node: NodeKey, name: &str) -> Option<&Parameter>

See ParameterServer::get_parameter in server.rs.

fn get_descriptor( &self, node: NodeKey, name: &str, ) -> Option<&ParameterDescriptor>

See ParameterServer::get_descriptor in server.rs.

fn set( &mut self, node: NodeKey, name: &str, value: ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::set in server.rs.

fn set_ref( &mut self, node: NodeKey, name: &str, value: &ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::set_ref in server.rs.

fn unset(&mut self, node: NodeKey, name: &str) -> Result<(), ParameterError>

See ParameterServer::unset in server.rs.

fn set_or_declare( &mut self, node: NodeKey, name: &str, value: ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::set_or_declare in server.rs.

fn has(&self, node: NodeKey, name: &str) -> bool

See ParameterServer::has in server.rs.

fn remove(&mut self, node: NodeKey, name: &str) -> bool

See ParameterServer::remove in server.rs.

fn get_type(&self, node: NodeKey, name: &str) -> Option<ParameterType>

See ParameterServer::get_type in server.rs.

fn iter(&self, node: NodeKey) -> impl Iterator<Item = &Parameter>

See ParameterServer::iter in server.rs.

fn list_names(&self, node: NodeKey) -> impl Iterator<Item = &str>

See ParameterServer::list_names in server.rs.

fn list_with_prefix<'a>( &'a self, node: NodeKey, prefix: &'a str, ) -> impl Iterator<Item = &'a str>

See ParameterServer::list_with_prefix in server.rs.

fn get_bool(&self, node: NodeKey, name: &str) -> Option<bool>

See ParameterServer::get_bool in server.rs.

fn get_integer(&self, node: NodeKey, name: &str) -> Option<i64>

See ParameterServer::get_integer in server.rs.

fn get_double(&self, node: NodeKey, name: &str) -> Option<f64>

See ParameterServer::get_double in server.rs.

fn get_string(&self, node: NodeKey, name: &str) -> Option<&str>

See ParameterServer::get_string in server.rs.

fn set_bool( &mut self, node: NodeKey, name: &str, value: bool, ) -> Result<(), ParameterError>

See ParameterServer::set_bool in server.rs.

fn set_integer( &mut self, node: NodeKey, name: &str, value: i64, ) -> Result<(), ParameterError>

See ParameterServer::set_integer in server.rs.

fn set_double( &mut self, node: NodeKey, name: &str, value: f64, ) -> Result<(), ParameterError>

See ParameterServer::set_double in server.rs.

fn set_string( &mut self, node: NodeKey, name: &str, value: &str, ) -> Result<(), ParameterError>

See ParameterServer::set_string in server.rs.

fn declare_parameter( &mut self, node: NodeKey, descriptor: ParameterDescriptor, initial_value: Option<&ParameterValue>, ) -> Result<(), ParameterError>

See ParameterServer::declare_parameter in server.rs.

fn get_parameter_value( &self, node: NodeKey, name: &str, ) -> Option<ParameterValue>

See ParameterServer::get_parameter_value in server.rs.

fn set_parameter_value( &mut self, node: NodeKey, name: &str, value: ParameterValue, ) -> Result<(), ParameterError>

See ParameterServer::set_parameter_value in server.rs.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<'s> ParameterServerOps<'s> for ParameterServer<'s>