Struct aamp::ParameterIO [−][src]
pub struct ParameterIO { pub version: u32, pub pio_type: String, pub lists: IndexMap<u32, ParameterList>, pub objects: IndexMap<u32, ParameterObject>, }
Expand description
Represents a single AAMP parameter IO document
Fields
version: u32
Expand description
The parameter IO version, required by the format but of no functional importance
pio_type: String
Expand description
The parameter IO type, required by the format but of no functional importance
lists: IndexMap<u32, ParameterList>
Expand description
The lists in the parameter IO root list (param_root
)
objects: IndexMap<u32, ParameterObject>
Expand description
The objects in the parameter IO root list (param_root
)
Implementations
impl ParameterIO
[src]
impl ParameterIO
[src]pub fn from_binary<R: Read + Seek>(
reader: &mut R
) -> Result<ParameterIO, ParseError>
[src]
pub fn from_binary<R: Read + Seek>(
reader: &mut R
) -> Result<ParameterIO, ParseError>
[src]Parses an AAMP Parameter IO document from its binary format. Takes any reader with the
Read and Seek traits and returns a result containing a ParameterIO
or a ParseError
.
impl ParameterIO
[src]
impl ParameterIO
[src]impl ParameterIO
[src]
impl ParameterIO
[src]pub fn to_text(&self) -> Result<String, Box<dyn Error>>
[src]
pub fn to_text(&self) -> Result<String, Box<dyn Error>>
[src]Returns a YAML representation of an AAMP parameter IO as a string. The output is fully
compatible with the representation used in the oead
C++ library, and compatible with the
representation used in the aamp
Python library except where buffer types are used.
pub fn write_text<W: Write>(&self, writer: &mut W) -> Result<(), Box<dyn Error>>
[src]
pub fn write_text<W: Write>(&self, writer: &mut W) -> Result<(), Box<dyn Error>>
[src]Writes a YAML document representing an AAMP parameter IO into a writer. The output is fully
compatible with the representation used in the oead
C++ library, and compatible with the
representation used in the aamp
Python library except where buffer types are used.
impl ParameterIO
[src]
impl ParameterIO
[src]pub fn from_text(text: &str) -> Result<ParameterIO, YamlParseError>
[src]
pub fn from_text(text: &str) -> Result<ParameterIO, YamlParseError>
[src]Parses an AAMP Parameter IO document from a YAML representation. Takes a string slice and
returns a result containing a ParameterIO
or a boxed error.
impl ParameterIO
[src]
impl ParameterIO
[src]pub fn list(&self, name: &str) -> Option<&ParameterList>
[src]
pub fn list(&self, name: &str) -> Option<&ParameterList>
[src]Attempt to get a ParameterList
by name, returns None if not found
pub fn object(&self, name: &str) -> Option<&ParameterObject>
[src]
pub fn object(&self, name: &str) -> Option<&ParameterObject>
[src]Attempt to get a ParameterObject
by name, returns None if not found
Trait Implementations
impl Clone for ParameterIO
[src]
impl Clone for ParameterIO
[src]fn clone(&self) -> ParameterIO
[src]
fn clone(&self) -> ParameterIO
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for ParameterIO
[src]
impl Debug for ParameterIO
[src]impl PartialEq<ParameterIO> for ParameterIO
[src]
impl PartialEq<ParameterIO> for ParameterIO
[src]fn eq(&self, other: &ParameterIO) -> bool
[src]
fn eq(&self, other: &ParameterIO) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &ParameterIO) -> bool
[src]
fn ne(&self, other: &ParameterIO) -> bool
[src]This method tests for !=
.
impl StructuralPartialEq for ParameterIO
[src]
Auto Trait Implementations
impl RefUnwindSafe for ParameterIO
impl Send for ParameterIO
impl Sync for ParameterIO
impl Unpin for ParameterIO
impl UnwindSafe for ParameterIO
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more