Struct RegionGuard

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

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

Methods from Deref<Target = Visitor>

pub const MAGIC: &'static str = "RG3D"

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 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 current_region(&self) -> Option<&str>

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 save_text(&self) -> String

Create a String containing all the data of this Visitor. 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<W>(&self, writer: W) -> Result<(), VisitError>

where W: Write,

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

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.

pub fn save_binary<P>(&self, path: P) -> Result<(), VisitError>

where P: AsRef<Path>,

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. Begin by writing Visitor::MAGIC.

Trait Implementations

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.

impl Deref for RegionGuard<'_>

type Target = Visitor

The resulting type after dereferencing.

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

Dereferences the value.