Struct reproto_trans::environment::Environment

pub struct Environment { /* fields omitted */ }

Scoped environment for evaluating reproto IDLs.

Methods

impl Environment

Environment containing all loaded declarations.

pub fn new(
    ctx: Rc<Context>,
    package_prefix: Option<RpPackage>,
    resolver: Box<Resolver>
) -> Environment

Construct a new, language-neutral environment.

pub fn with_safe_packages(self, safe_packages: bool) -> Self

Configure a new environment on how to use safe packages or not.

pub fn with_keywords(self, keywords: HashMap<String, String>) -> Self

Build the environment with the given keywords.

pub fn with_package_naming(self, package_naming: Box<Naming>) -> Self

Set package naming policy.

pub fn with_field_ident_naming(self, field_ident_naming: Box<Naming>) -> Self

Set field naming policy.

pub fn lookup<'a>(&'a self, name: &RpName) -> Result<&'a RpReg>

Lookup the declaration matching the given name.

Returns the registered reference, if present.

pub fn import_path<P: AsRef<Path>>(
    &mut self,
    path: P,
    package: Option<RpVersionedPackage>
) -> Result<RpVersionedPackage>

Import a path into the environment.

pub fn import_object(
    &mut self,
    object: &Object,
    package: Option<RpVersionedPackage>
) -> Result<RpVersionedPackage>

Import an object into the environment.

pub fn import_file(
    &mut self,
    file: File,
    package: Option<RpVersionedPackage>
) -> Result<RpVersionedPackage>

Import a single, structured file object.

pub fn import(
    &mut self,
    required: &RpRequiredPackage
) -> Result<Option<RpVersionedPackage>>

Import a package based on a package and version criteria.

pub fn verify(&mut self) -> Result<()>

Verify all declarations.

Important traits for ForEachFile<'a>

impl<'a> Iterator for ForEachFile<'a> type Item = (&'a RpVersionedPackage, &'a RpFile);

pub fn for_each_file(&self) -> ForEachFile

Iterate over all files.

Important traits for ToplevelDeclIter<'a>

impl<'a> Iterator for ToplevelDeclIter<'a> type Item = &'a RpDecl;

pub fn toplevel_decl_iter(&self) -> ToplevelDeclIter

Iterate over top level declarations of all registered objects.

Important traits for DeclIter<'a>

impl<'a> Iterator for DeclIter<'a> type Item = &'a RpDecl;

pub fn decl_iter(&self) -> DeclIter

Walks the entire tree of declarations recursively of all registered objects.

pub fn load_object(
    &mut self,
    object: &Object,
    package: &RpVersionedPackage
) -> Result<RpFile>

Load the provided Object into an RpFile without registering it to the set of visited files.

Trait Implementations