Struct RegionGuard 

pub struct RegionGuard<'a>(/* private fields */);

A RegionGuard is a Visitor wrapper that automatically leaves the current region when it is dropped.

Methods from Deref<Target = Visitor>

pub const MAGIC_BINARY_CURRENT: &'static str = "FBAF"

pub const MAGIC_ASCII_CURRENT: &'static str = "FTAX"

pub fn find_field(&mut self, name: &str) -> Option<&mut Field>

Tries to find a field by its name.

pub fn find_node(&self, name: &str) -> Option<&VisitorNode>

Tries to find a node by its name.

pub fn is_reading(&self) -> bool

True if this Visitor is changing the values that it visits. In other words, x.visit("MyValue", &mut visitor) will result in x being mutated to match whatever value is stored in visitor.

False if this visitor is copying and storing the values that it visits. In other words, x.visit("MyValue", &mut visitor) will result in x being unchanged, but visitor will be mutated to store the value of x under the name “MyValue”.

pub fn version(&self) -> u32

Returns version number of the visitor.

pub fn has_region(&self, name: &str) -> bool

Returns true of a region with the given name exists as a child of the current node. When reading, has_region returning true means that enter_region will succeed. When writing, has_region returning true means that enter_region will fail.

pub fn enter_region( &mut self, name: &str, ) -> Result<RegionGuard<'_>, VisitError>

If Visitor::is_reading, find a node with the given name that is a child of the current node, and return a Visitor for the found node. Return an error if no node with that name exists.

If not reading, create a node with the given name as a chld of the current node, and return a visitor for the new node. Return an error if a node with that name already exists.

pub fn breadcrumbs(&self) -> String

Return a string representing all the regions from the root to the current node.

pub fn current_region(&self) -> Result<&str, PoolError>

The name of the current region. This should never be None if the Visitor is operating normally, because there should be no way to leave the initial __ROOT__ region.

pub fn debug(&self) -> String

Get the content of the current node in human-readable form.

pub fn debug_to<W>(&self, w: &mut W) -> Result<(), VisitError>

where W: Write,

Write the content of the current node in human-readable form.

pub fn save_ascii_to_string(&self) -> String

Create a string containing all the data of this Visitor in ascii form. The string is formatted to be human-readable with each node on its own line and tabs to indent child nodes.

pub fn save_ascii_to_file( &self, path: impl AsRef<Path>, ) -> Result<(), VisitError>

Create a string containing all the data of this Visitor in ascii form and saves it to the given path. The string is formatted to be human-readable with each node on its own line and tabs to indent child nodes.

pub fn save_ascii_to_memory(&self, dest: impl Write) -> Result<(), VisitError>

Create a string containing all the data of this Visitor in ascii form and writes it to the given writer. The string is formatted to be human-readable with each node on its own line and tabs to indent child nodes.

pub fn save_binary_to_memory(&self, dest: impl Write) -> Result<(), VisitError>

Write the data of this Visitor to the given writer. Begin by writing Visitor::MAGIC_BINARY_CURRENT.

pub fn save_binary_to_vec(&self) -> Result<Vec<u8>, VisitError>

Encode the data of this visitor into bytes and push the bytes into the given Vec<u8>. Begin by writing Visitor::MAGIC_BINARY_CURRENT.

pub fn save_binary_to_file( &self, path: impl AsRef<Path>, ) -> Result<(), VisitError>

Create a file at the given path and write the data of this visitor into that file in a non-human-readable binary format so that the data can be reconstructed using Visitor::load_binary_from_file. Begin by writing Visitor::MAGIC_BINARY_CURRENT.

Trait Implementations

impl Deref for RegionGuard<'_>

type Target = Visitor

The resulting type after dereferencing.

fn deref(&self) -> &<RegionGuard<'_> as Deref>::Target

Dereferences the value.

impl DerefMut for RegionGuard<'_>

fn deref_mut(&mut self) -> &mut <RegionGuard<'_> as Deref>::Target

Mutably dereferences the value.

impl Drop for RegionGuard<'_>

fn drop(&mut self)

Executes the destructor for this type.