Struct BrowseFilter

pub struct BrowseFilter { /* private fields */ }

Simple filter for the Browser. All discovered nodes will be recursively browsed using the stored configuration.

Implementations

impl BrowseFilter

pub fn new( direction: BrowseDirection, reference_type_id: impl Into<NodeId>, include_subtypes: bool, ) -> Self

Create a new browse filter for browsing references of reference_type_id (optionally including subtypes) in the given direction.

pub fn new_description_from_node(&self, node_id: NodeId) -> BrowseDescription

Create a new browse description from this filter and a node ID to browse.

pub fn new_hierarchical() -> Self

Create a new browse filter for browsing hierarchical references.

pub fn node_class_mask(self, mask: NodeClassMask) -> Self

Set the node class mask, the filter for allowed node classes in the returned references. Defaults to all.

pub fn result_mask(self, mask: BrowseResultMaskFlags) -> Self

Set the result mask, indicating which values should be returned for each reference. Defaults to all.

pub fn max_depth(self, depth: usize) -> Self

Set the maximum browse depth. If this is 1 only the root nodes will be browsed, if it is 0, there is no upper limit.

Trait Implementations

impl BrowserPolicy for BrowseFilter

fn get_next(&self, results: &BrowseResultItem) -> Vec<BrowseDescription>

Given a parent node, and a list of references from that node, return a list of nodes to browse next.

impl Clone for BrowseFilter

fn clone(&self) -> BrowseFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrowseFilter

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

Formats the value using the given formatter.