Enum cumulus_primitives_core::Junctions

pub enum Junctions {
    Here,
    X1(Junction),
    X2(Junction, Junction),
    X3(Junction, Junction, Junction),
    X4(Junction, Junction, Junction, Junction),
    X5(Junction, Junction, Junction, Junction, Junction),
    X6(Junction, Junction, Junction, Junction, Junction, Junction),
    X7(Junction, Junction, Junction, Junction, Junction, Junction, Junction),
    X8(Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction),
}

Expand description

Non-parent junctions that can be constructed, up to the length of 8. This specific Junctions implementation uses a Rust enum in order to make pattern matching easier.

Parent junctions cannot be constructed with this type. Refer to MultiLocation for instructions on constructing parent junctions.

Variants§

§

Here

The interpreting consensus system.

§

X1(Junction)

A relative path comprising 1 junction.

§

X2(Junction, Junction)

A relative path comprising 2 junctions.

§

X3(Junction, Junction, Junction)

A relative path comprising 3 junctions.

§

X4(Junction, Junction, Junction, Junction)

A relative path comprising 4 junctions.

§

X5(Junction, Junction, Junction, Junction, Junction)

A relative path comprising 5 junctions.

§

X6(Junction, Junction, Junction, Junction, Junction, Junction)

A relative path comprising 6 junctions.

§

X7(Junction, Junction, Junction, Junction, Junction, Junction, Junction)

A relative path comprising 7 junctions.

§

X8(Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction)

A relative path comprising 8 junctions.

Implementations§

§

impl Junctions

pub const fn into_location(self) -> MultiLocation

Convert self into a MultiLocation containing 0 parents.

Similar to Into::into, except that this method can be used in a const evaluation context.

pub const fn into_exterior(self, n: u8) -> MultiLocation

Convert self into a MultiLocation containing n parents.

Similar to Self::into_location, with the added ability to specify the number of parent junctions.

pub fn remove_network_id(&mut self)

Remove the NetworkId value in any Junctions.

pub fn invert_target(self, target: &MultiLocation) -> Result<MultiLocation, ()>

Treating self as the universal context, return the location of the local consensus system from the point of view of the given target.

pub fn for_each_mut(&mut self, x: impl FnMut(&mut Junction))

Execute a function f on every junction. We use this since we cannot implement a mutable Iterator without unsafe code.

pub fn global_consensus(&self) -> Result<NetworkId, ()>

Extract the network ID treating this value as a universal location.

This will return an Err if the first item is not a GlobalConsensus, which would indicate that this value is not a universal location.

pub fn split_global(self) -> Result<(NetworkId, Junctions), ()>

Extract the network ID and the interior consensus location, treating this value as a universal location.

This will return an Err if the first item is not a GlobalConsensus, which would indicate that this value is not a universal location.

pub fn within_global(self, relative: MultiLocation) -> Result<Junctions, ()>

Treat self as a universal location and the context of relative, returning the universal location of relative.

This will return an error if relative has as many (or more) parents than there are junctions in self, implying that relative refers into a different global consensus.

pub fn relative_to(self, viewer: &Junctions) -> MultiLocation

Consumes self and returns how viewer would address it locally.

pub fn first(&self) -> Option<&Junction>

Returns first junction, or None if the location is empty.

pub fn last(&self) -> Option<&Junction>

Returns last junction, or None if the location is empty.

pub fn split_first(self) -> (Junctions, Option<Junction>)

Splits off the first junction, returning the remaining suffix (first item in tuple) and the first element (second item in tuple) or None if it was empty.

pub fn split_last(self) -> (Junctions, Option<Junction>)

Splits off the last junction, returning the remaining prefix (first item in tuple) and the last element (second item in tuple) or None if it was empty.

pub fn take_first(&mut self) -> Option<Junction>

Removes the first element from self, returning it (or None if it was empty).

pub fn take_last(&mut self) -> Option<Junction>

Removes the last element from self, returning it (or None if it was empty).

pub fn push(&mut self, new: impl Into<Junction>) -> Result<(), Junction>

Mutates self to be appended with new or returns an Err with new if would overflow.

pub fn push_front(&mut self, new: impl Into<Junction>) -> Result<(), Junction>

Mutates self to be prepended with new or returns an Err with new if would overflow.

pub fn pushed_with( self, new: impl Into<Junction> ) -> Result<Junctions, (Junctions, Junction)>

Consumes self and returns a Junctions suffixed with new, or an Err with the original value of self and new in case of overflow.

pub fn pushed_front_with( self, new: impl Into<Junction> ) -> Result<Junctions, (Junctions, Junction)>

Consumes self and returns a Junctions prefixed with new, or an Err with the original value of self and new in case of overflow.

pub fn append_with( &mut self, suffix: impl Into<Junctions> ) -> Result<(), Junctions>

Mutate self so that it is suffixed with suffix.

Does not modify self and returns Err with suffix in case of overflow.

Example

let mut m = X1(Parachain(21));
assert_eq!(m.append_with(X1(PalletInstance(3))), Ok(()));
assert_eq!(m, X2(Parachain(21), PalletInstance(3)));

pub const fn len(&self) -> usize

Returns the number of junctions in self.

pub fn at(&self, i: usize) -> Option<&Junction>

Returns the junction at index i, or None if the location doesn’t contain that many elements.

pub fn at_mut(&mut self, i: usize) -> Option<&mut Junction>

Returns a mutable reference to the junction at index i, or None if the location doesn’t contain that many elements.

pub fn iter(&self) -> JunctionsRefIterator<'_>

Returns a reference iterator over the junctions.

pub fn match_and_split(&self, prefix: &Junctions) -> Option<&Junction>

Ensures that self begins with prefix and that it has a single Junction item following. If so, returns a reference to this Junction item.

Example

let mut m = X3(Parachain(2), PalletInstance(3), OnlyChild);
assert_eq!(m.match_and_split(&X2(Parachain(2), PalletInstance(3))), Some(&OnlyChild));
assert_eq!(m.match_and_split(&X1(Parachain(2))), None);

pub fn starts_with(&self, prefix: &Junctions) -> bool

Trait Implementations§

§

impl Clone for Junctions

§

fn clone(&self) -> Junctions

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

§

impl Debug for Junctions

§

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

Formats the value using the given formatter. Read more

§

impl Decode for Junctions

§

fn decode<CodecInputEdqy>( codec_input_edqy: &mut CodecInputEdqy ) -> Result<Junctions, Error>where CodecInputEdqy: Input,

Attempt to deserialise the value from input.

§

fn decode_into( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory. Read more

§

fn skip(input: &mut I) -> Result<(), Error>where I: Input,

Attempt to skip the encoded value from input. Read more

§

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type. Read more

§

impl<'de> Deserialize<'de> for Junctions

§

fn deserialize<D>( deserializer: D ) -> Result<Junctions, <D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

§

impl Encode for Junctions

§

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding. Read more

§

fn encode_to<CodecOutputEdqy>( &self, codec_dest_edqy: &mut CodecOutputEdqy )where CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

§

fn encode(&self) -> Vec<u8, Global> ⓘ

Convert self to an owned vector.

§

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

§

fn encoded_size(&self) -> usize

Calculates the encoded size. Read more

§