Skip to main content

MethodBuilder

Struct MethodBuilder 

Source
pub struct MethodBuilder { /* private fields */ }
Expand description

A builder for constructing a node of same name. This can be used as an easy way to create a node and the references it has to another node in a simple fashion.

Implementations§

Source§

impl MethodBuilder

Source

pub fn new<T, S>(node_id: &NodeId, browse_name: T, display_name: S) -> Self

Creates a builder for a node. All nodes are required to su

Source

pub fn get_node_id(&self) -> NodeId

Source

pub fn is_valid(&self) -> bool

Tests that the builder is in a valid state to build or insert the node.

Source

pub fn description<V>(self, description: V) -> Self
where V: Into<LocalizedText>,

Sets the description of the node

Source

pub fn reference<T>( self, node_id: T, reference_type_id: ReferenceTypeId, reference_direction: ReferenceDirection, ) -> Self
where T: Into<NodeId>,

Adds a reference to the node

Source

pub fn organizes<T>(self, organizes_id: T) -> Self
where T: Into<NodeId>,

Indicates this node organizes another node by its id.

Source

pub fn organized_by<T>(self, organized_by_id: T) -> Self
where T: Into<NodeId>,

Indicates this node is organised by another node by its id

Source

pub fn build(self) -> Method

Yields a built node. This function will panic if the node is invalid. Note that calling this function discards any references for the node, so there is no purpose in adding references if you intend to call this method.

Source

pub fn insert(self, address_space: &mut AddressSpace) -> bool

Inserts the node into the address space, including references. This function will panic if the node is in an invalid state.

Source§

impl MethodBuilder

Source

pub fn component_of<T>(self, component_of_id: T) -> Self
where T: Into<NodeId>,

Source

pub fn has_component<T>(self, has_component_id: T) -> Self
where T: Into<NodeId>,

Source§

impl MethodBuilder

Source

pub fn generates_event<T>(self, event_type: T) -> Self
where T: Into<NodeId>,

Source§

impl MethodBuilder

Source

pub fn output_args( self, address_space: &mut AddressSpace, arguments: &[Argument], ) -> Self

Specify output arguments from the method. This will create an OutputArguments variable child of the method which describes the out parameters.

Source

pub fn input_args( self, address_space: &mut AddressSpace, arguments: &[Argument], ) -> Self

Specify input arguments to the method. This will create an InputArguments variable child of the method which describes the in parameters.

Source

pub fn callback(self, callback: Box<dyn Method + Send + Sync>) -> Self

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