Enum xcm::v0::MultiLocation

pub enum MultiLocation {
    Null,
    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),
}

A relative path between state-bearing consensus systems.

A location in a consensus system is defined as an isolatable state machine held within global consensus. The location in question need not have a sophisticated consensus algorithm of its own; a single account within Ethereum, for example, could be considered a location.

A very-much non-exhaustive list of types of location include:

• A (normal, layer-1) block chain, e.g. the Bitcoin mainnet or a parachain.
• A layer-0 super-chain, e.g. the Polkadot Relay chain.
• A layer-2 smart contract, e.g. an ERC-20 on Ethereum.
• A logical functional component of a chain, e.g. a single instance of a pallet on a Frame-based Substrate chain.
• An account.

A MultiLocation is a relative identifier, meaning that it can only be used to define the relative path between two locations, and cannot generally be used to refer to a location universally. It is comprised of a number of junctions, each morphing the previous location, either diving down into one of its internal locations, called a sub-consensus, or going up into its parent location. Correct MultiLocation values must have all Parent junctions as a prefix to all sub-consensus junctions.

This specific MultiLocation implementation uses a Rust enum in order to make pattern matching easier.

The MultiLocation value of Null simply refers to the interpreting consensus system.

Variants

Null

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 MultiLocation

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) -> (MultiLocation, 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) -> (MultiLocation, 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 pushed_with(self, new: Junction) -> Result<Self, Self>

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

pub fn pushed_front_with(self, new: Junction) -> Result<Self, Self>

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

pub 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) -> MultiLocationRefIterator<'_>

Returns a reference iterator over the junctions.

pub fn iter_rev(&self) -> MultiLocationReverseRefIterator<'_>

Returns a reference iterator over the junctions in reverse.

pub fn into_iter(self) -> MultiLocationIterator

Consumes self and returns an iterator over the junctions.

pub fn into_iter_rev(self) -> MultiLocationReverseIterator

Consumes self and returns an iterator over the junctions in reverse.

pub fn match_and_split(&self, prefix: &MultiLocation) -> 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(Parent, PalletInstance(3), OnlyChild);
assert_eq!(m.match_and_split(&X2(Parent, PalletInstance(3))), Some(&OnlyChild));
assert_eq!(m.match_and_split(&X1(Parent)), None);

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

Mutates self, suffixing it with new. Returns Err in case of overflow.

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

Mutates self, prefixing it with new. Returns Err in case of overflow.

pub fn leading_parent_count(&self) -> usize

Returns the number of Parent junctions at the beginning of self.

pub fn canonicalize(&mut self)

This function ensures a multi-junction is in its canonicalized/normalized form, removing any internal [Non-Parent, Parent] combinations.

pub fn append_with(&mut self, suffix: MultiLocation) -> Result<(), MultiLocation>

Mutate self so that it is suffixed with suffix. The correct normalized form is returned, removing any internal [Non-Parent, Parent] combinations.

In the case of overflow, self is unmodified and we return Err with suffix.

Example

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

pub fn prepend_with(
    &mut self,
    prefix: MultiLocation
) -> Result<(), MultiLocation>

Mutate self so that it is prefixed with prefix. The correct normalized form is returned, removing any internal [Non-Parent, Parent] combinations.

In the case of overflow, self is unmodified and we return Err with prefix.

Example

let mut m = X3(Parent, Parent, PalletInstance(3));
assert_eq!(m.prepend_with(X3(Parent, Parachain(21), OnlyChild)), Ok(()));
assert_eq!(m, X2(Parent, PalletInstance(3)));

pub fn is_interior(&self) -> bool

Returns true iff self is an interior location. For this it may not contain any Junctions for which Junction::is_interior returns false. This is generally true, except for the Parent item.

Example

let parent = X1(Parent);
assert_eq!(parent.is_interior(), false);
let m = X2(PalletInstance(12), AccountIndex64 { network: Any, index: 23 });
assert_eq!(m.is_interior(), true);

Trait Implementations

impl Clone for MultiLocation

fn clone(&self) -> MultiLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiLocation

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

Formats the value using the given formatter.

impl Decode for MultiLocation

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for MultiLocation

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

fn size_hint(&self) -> usize

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

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.

impl From<[Junction; 0]> for MultiLocation

fn from(_: [Junction; 0]) -> Self

Converts to this type from the input type.

impl From<[Junction; 1]> for MultiLocation

fn from(j: [Junction; 1]) -> Self

Converts to this type from the input type.

impl From<[Junction; 2]> for MultiLocation

fn from(j: [Junction; 2]) -> Self

Converts to this type from the input type.

impl From<[Junction; 3]> for MultiLocation

fn from(j: [Junction; 3]) -> Self

Converts to this type from the input type.

impl From<[Junction; 4]> for MultiLocation

fn from(j: [Junction; 4]) -> Self

Converts to this type from the input type.

impl From<[Junction; 5]> for MultiLocation

fn from(j: [Junction; 5]) -> Self

Converts to this type from the input type.

impl From<[Junction; 6]> for MultiLocation

fn from(j: [Junction; 6]) -> Self

Converts to this type from the input type.

impl From<[Junction; 7]> for MultiLocation

fn from(j: [Junction; 7]) -> Self

Converts to this type from the input type.

impl From<[Junction; 8]> for MultiLocation

fn from(j: [Junction; 8]) -> Self

Converts to this type from the input type.

impl From<()> for MultiLocation

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction)> for MultiLocation

fn from(
    (j0, j1, j2, j3, j4, j5, j6, j7): (Junction, Junction, Junction, Junction, Junction, Junction, Junction, Junction)
) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction, Junction, Junction, Junction, Junction, Junction)> for MultiLocation

fn from(
    (j0, j1, j2, j3, j4, j5, j6): (Junction, Junction, Junction, Junction, Junction, Junction, Junction)
) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction, Junction, Junction, Junction, Junction)> for MultiLocation

fn from(
    (j0, j1, j2, j3, j4, j5): (Junction, Junction, Junction, Junction, Junction, Junction)
) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction, Junction, Junction, Junction)> for MultiLocation

fn from(
    (j0, j1, j2, j3, j4): (Junction, Junction, Junction, Junction, Junction)
) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction, Junction, Junction)> for MultiLocation

fn from((j0, j1, j2, j3): (Junction, Junction, Junction, Junction)) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction, Junction)> for MultiLocation

fn from((j0, j1, j2): (Junction, Junction, Junction)) -> Self

Converts to this type from the input type.

impl From<(Junction, Junction)> for MultiLocation

fn from((j0, j1): (Junction, Junction)) -> Self

Converts to this type from the input type.

impl From<(Junction,)> for MultiLocation

fn from((j0): (Junction,)) -> Self

Converts to this type from the input type.

impl From<Junction> for MultiLocation

fn from(x: Junction) -> Self

Converts to this type from the input type.

impl From<MultiLocation> for VersionedMultiLocation

fn from(x: MultiLocation) -> Self

Converts to this type from the input type.

impl Ord for MultiLocation

fn cmp(&self, other: &MultiLocation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<MultiLocation> for MultiLocation

fn eq(&self, other: &MultiLocation) -> 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 PartialOrd<MultiLocation> for MultiLocation

fn partial_cmp(&self, other: &MultiLocation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<MultiLocation> for MultiLocation

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v1: MultiLocation) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<MultiLocation> for MultiLocation

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v0: MultiLocation) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<VersionedMultiLocation> for MultiLocation

type Error = ()

The type returned in the event of a conversion error.

fn try_from(x: VersionedMultiLocation) -> Result<Self, ()>

Performs the conversion.

impl TypeInfo for MultiLocation

type Identity = MultiLocation

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike<MultiLocation> for MultiLocation

impl Eq for MultiLocation

impl StructuralEq for MultiLocation

impl StructuralPartialEq for MultiLocation