Struct cborpath::CborPath

pub struct CborPath(_);

Represents a CBORPath expression

Once constructed, this structure can be used efficiently multiple times to apply the CBOR Path expression on different CBOR documents.

Implementations

impl CborPath

pub fn builder() -> PathBuilder

Initialize a CborPath instance from a builder

Return

A new CborPath instance

pub fn from_bytes(cbor: &[u8]) -> Result<Self, Error>

Initialize a CborPath instance from a CBOR binary buffer

Arguments

• cbor - the CBOR input document

Return

A new CborPath instance or an error if the provided buffer is neither a valid CBOR buffer nor a valid CBORPath expression.

pub fn from_value(cbor: &Cbor) -> Result<Self, Error>

Initialize a CborPath instance from a CBOR value reference

Arguments

• cbor - the CBOR input document

Return

A new CborPath instance or an error if the provided buffer is the provided [CBOR value] is not a valid CBORPath expression.

pub fn root() -> Self

Initialize a CborPath instance as a root path

pub fn is_root(&self) -> bool

Return true if the CBORPath is a root path ($) else false

pub fn read<'a>(&self, cbor: &'a Cbor) -> Vec<&'a Cbor>

Applies the CBORPath expression to the input CBOR document

Arguments

• cbor - the CBOR input document

Return

A binarized CBOR document

The returned value is always in a the form of a CBOR Array which contains all the results CBOR nodes

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, an empty CBOR Array will be returned.

pub fn read_from_bytes(&self, cbor: &[u8]) -> Result<Vec<u8>, Error>

Applies the CBORPath expression to the input CBOR document

Arguments

• cbor - the CBOR input document

Return

A binarized CBOR document.

The returned value is always in a the form of a CBOR Array which contains all the results CBOR nodes

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, an empty CBOR Array will be returned.

Errors can only occur if the input buffer is not a valid CBOR document.

pub fn get_paths(&self, cbor: &Cbor) -> Vec<Path>

Applies the CBORPath expression to the input CBOR document

Arguments

• cbor - the CBOR input document

Return

A path list to matched nodes.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, an empty list will be returned.

pub fn get_paths_from_bytes(&self, cbor: &[u8]) -> Result<Vec<Path>, Error>

Applies the CBORPath expression to the input CBOR document

Arguments

• cbor - the CBOR input document

Return

A path list to matched nodes.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, an empty list will be returned.

Errors can only occur if the input buffer is not a valid CBOR document.

pub fn write<'a, F>( &self, cbor: &'a Cbor, map_function: F ) -> Result<Option<CborOwned>, Error>where F: FnMut(&'a Cbor) -> Result<Option<Cow<'a, Cbor>>, Error>,

Replaces or deletes the value on the given path with the result of the map_function

Arguments

• cbor - the CBOR input document
• map_function - Returns a converted CBOR sub-document to replace the input CBOR sub-document or None to delete the input sub-document.

Return

The updated CBOR document or None if the CBORPath expression does not match the input value.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, the input CBOR document will be returned.

pub fn write_from_bytes<'a, F>( &self, cbor: &'a [u8], map_function: F ) -> Result<Option<Vec<u8>>, Error>where F: FnMut(&'a [u8]) -> Result<Option<Cow<'a, [u8]>>, Error>,

Replaces or deletes the value on the given path with the result of the map_function

Arguments

• cbor - the CBOR input document
• map_function - Returns a converted CBOR sub-document to replace the input CBOR sub-document or None to delete the input sub-document.

Return

The updated CBOR document or None if the CBORPath expression does not match the input value.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, the input CBOR document will be returned.

Errors can only occur if the input buffer is not a valid CBOR document.

pub fn set<'a>(&self, cbor: &'a Cbor, new_val: &'a Cbor) -> Option<CborOwned>

Sets the new_val this path points to in the provided cbor document

Arguments

• cbor - the CBOR input document
• new_val - the CBOR sub-document to set

Return

The updated CBOR document or None if the CBORPath expression does not match the input value.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, the input CBOR document will be returned.

pub fn set_from_bytes<'a>( &self, cbor: &'a [u8], new_val: &'a [u8] ) -> Result<Option<Vec<u8>>, Error>

Sets the new_val this path points to in the provided cbor document

Arguments

• cbor - the CBOR input document
• new_val - the CBOR sub-document to set

Return

The updated CBOR document or None if the CBORPath expression does not match the input value.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, the input CBOR document will be returned.

Errors can only occur if the input buffer is not a valid CBOR document.

pub fn delete(&self, cbor: &Cbor) -> Option<CborOwned>

Deletes the CBOR sub-documents this path points to in the provided cbordocument

Arguments

• cbor - the CBOR input document

Return

The updated CBOR document or None if the CBORPath expression does not match the input value.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, the input CBOR document will be returned.

pub fn delete_from_byte(&self, cbor: &[u8]) -> Result<Option<Vec<u8>>, Error>

Deletes the CBOR sub-documents this path points to in the provided cbordocument

Arguments

• cbor - the CBOR input document

Return

The updated CBOR document or None if the CBORPath expression does not match the input value.

The evaluation in itself does not raise any error: if the CBORPath expression does not match the input value, the input CBOR document will be returned.

Errors can only occur if the input buffer is not a valid CBOR document.

Trait Implementations

impl Debug for CborPath

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

Formats the value using the given formatter.

impl PartialEq<CborPath> for CborPath

fn eq(&self, other: &CborPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&Cbor> for CborPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Cbor) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for CborPath