Struct Address

Source
pub struct Address<A: Afi>(/* private fields */);
Expand description

An IP address of address family A.

Implementations§

Source§

impl<A: Afi> Address<A>

Source

pub const fn new(inner: A::Primitive) -> Self

Construct a new Address<A> from an integer primitive appropriate to A.

Source

pub const fn into_primitive(self) -> A::Primitive

Get the primitive integer value, consuming self.

Source§

impl Address<Ipv4>

Source

pub const BROADCAST: Self

The IPv4 subnet-local broadcast address 255.255.255.255.

Source

pub fn to_ipv6_compatible(&self) -> Address<Ipv6>

Converts this Address<Ipv4> to an IPv4-compatible Address<Ipv6>.

IPv4-compatible IPv6 addresses are of the form ::a.b.c.d, where a.b.c.d is the corresponding IPv4 address. See RFC 4291.

§Examples
use ip::{Address, Ipv4, Ipv6};

assert_eq!(
    "172.16.12.1".parse::<Address<Ipv4>>()?.to_ipv6_compatible(),
    "::172.16.12.1".parse::<Address<Ipv6>>()?,
);
Source

pub fn to_ipv6_mapped(&self) -> Address<Ipv6>

Converts this Address<Ipv4> to an IPv4-mapped Address<Ipv6>.

IPv4-mapped IPv6 addresses are of the form ::ffff:a.b.c.d, where a.b.c.d is the corresponding IPv4 address. See RFC 4291.

§Examples
use ip::{Address, Ipv4, Ipv6};

assert_eq!(
    "172.16.12.1".parse::<Address<Ipv4>>()?.to_ipv6_mapped(),
    "::ffff:172.16.12.1".parse::<Address<Ipv6>>()?,
);
Source§

impl Address<Ipv6>

Returns true if the address is unicast link local.

This method is provided for compatibility with std::net::Ipv6Addr, and is just a wrapper around Address::is_link_local().

Source

pub fn multicast_scope(&self) -> Option<MulticastScope>

Returns the Ipv6MulticastScope variant of the address if the address is a multicast address, or None otherwise.

§Examples
use ip::{concrete::Ipv6MulticastScope, Address, Ipv6};

let ipv6_site_local_multicast = "ff05::1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv6_site_local_multicast.multicast_scope(),
    Some(Ipv6MulticastScope::SiteLocal),
);

let ipv6_global_multicast = "ff0e::1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv6_global_multicast.multicast_scope(),
    Some(Ipv6MulticastScope::Global),
);

let ipv6_unicast = "2001:db8::1".parse::<Address<Ipv6>>()?;
assert_eq!(ipv6_unicast.multicast_scope(), None,);
Source

pub fn segments(&self) -> [u16; 8]

Returns a big-endian [[u16; 8]] representing the segments of the address.

§Examples
use ip::{Address, Ipv6};

assert_eq!(
    "2001:db8:f00::1".parse::<Address<Ipv6>>()?.segments(),
    [0x2001, 0xdb8, 0xf00, 0x0, 0x0, 0x0, 0x0, 0x1],
);
Source

pub fn to_canonical(&self) -> Address

Convert the address to its canonical representation as an any::Address, by converting an IPv4-mapped address to a any::Address::Ipv4, and returning an any::Address::Ipv6 otherwise.

§Examples
use ip::{Address, Any, Ipv6};

let ipv4_mapped = "::ffff:192.168.1.1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv4_mapped.to_canonical(),
    "192.168.1.1".parse::<Address<Any>>()?,
);

let ipv6_unicast = "2001:db8::1".parse::<Address<Ipv6>>()?;
assert_eq!(
    ipv6_unicast.to_canonical(),
    Address::<Any>::Ipv6(ipv6_unicast),
);
Source

pub fn to_ipv4(&self) -> Option<Address<Ipv4>>

Returns the embedded Address<Ipv4> in an IPv4-compatible or IPv4-mapped Address<Ipv6>, or None otherwise.

§Examples
use ip::{Address, Ipv6};

assert_eq!(
    "::192.168.1.1"
        .parse::<Address<Ipv6>>()?
        .to_ipv4()
        .map(|ipv4| ipv4.octets()),
    Some([192, 168, 1, 1]),
);

assert_eq!("2001:db8::1".parse::<Address<Ipv6>>()?.to_ipv4(), None,);
Source

pub fn to_ipv4_mapped(&self) -> Option<Address<Ipv4>>

Returns the embedded Address<Ipv4> in an IPv4-mapped Address<Ipv6>, or None otherwise.

§Examples
use ip::{Address, Ipv6};

assert_eq!(
    "::ffff:172.16.1.1"
        .parse::<Address<Ipv6>>()?
        .to_ipv4_mapped()
        .map(|ipv4| ipv4.octets()),
    Some([172, 16, 1, 1]),
);

assert_eq!(
    "::192.168.1.1".parse::<Address<Ipv6>>()?.to_ipv4_mapped(),
    None,
);

assert_eq!(
    "2001:db8::1".parse::<Address<Ipv6>>()?.to_ipv4_mapped(),
    None,
);
Source§

impl<A: Afi> Address<A>

Source

pub const LOCALHOST: Self

The localhost address for address family A.

Source

pub const UNSPECIFIED: Self

The “unspecified” address for address family A.

Source

pub const ZEROS: Self

The “all-zeros” address for address family A.

Source

pub fn from_octets(octets: A::Octets) -> Self

Construct a new Address<A> from a big-endian byte-array.

§Examples
use ip::{Address, Ipv4, Ipv6};

assert_eq!(
    Address::<Ipv4>::from_octets([10, 0, 0, 1]),
    "10.0.0.1".parse::<Address<Ipv4>>()?,
);

assert_eq!(
    Address::<Ipv6>::from_octets([0x20, 0x01, 0x0d, 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1,]),
    "2001:db8::1".parse::<Address<Ipv6>>()?,
);
Source

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

Try to construct a new Address<A> from a big-endian slice of octets.

If slice is shorter than A::Octets then the missing low-order octets will be zero-filled.

§Errors

An error of kind OctetSliceOverrun will be returned if the length of slice is greater than the length of A::Octets.

§Examples
use ip::{Address, Ipv4, Ipv6};

assert_eq!(
    Address::<Ipv6>::from_slice(&[0x20, 0x01, 0x0d, 0xb8])?,
    "2001:db8::".parse::<Address<Ipv6>>()?,
);

assert!(matches!(
    Address::<Ipv4>::from_slice(&[1, 2, 3, 4, 5]),
    Err(_),
));
Source

pub fn octets(&self) -> A::Octets

Returns a big-endian byte-array representing the value of self.

§Examples
use ip::{Address, Ipv4, Ipv6};

assert_eq!("10.0.0.1".parse::<Address<Ipv4>>()?.octets(), [10, 0, 0, 1],);

assert_eq!(
    "2001:db8::1".parse::<Address<Ipv6>>()?.octets(),
    [0x20, 0x01, 0x0d, 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x01],
);
Source

pub fn common_length(self, other: Self) -> PrefixLength<A>

Compute the common length of self and another Address<A>.

See also common_length().

Trait Implementations§

Source§

impl<A: Afi, T: Type> Add<Mask<T, A>> for Address<A>

Source§

type Output = Option<Address<A>>

The resulting type after applying the + operator.
Source§

fn add(self, mask: Mask<T, A>) -> Self::Output

Performs the + operation. Read more
Source§

impl<A: Afi> Address for Address<A>

Source§

fn afi(&self) -> Afi

Returns the address-family associated with this IP address. Read more
Source§

fn is_broadcast(&self) -> bool

Returns true if this is an IPv4 broadcast address (255.255.255.255). Returns false for all IPv6 addresses. Read more
Returns true if the address is link-local. Read more
Source§

fn is_private(&self) -> bool

Returns true if this is a private IPv4 address. Returns false for all IPv6 addresses. Read more
Source§

fn is_reserved(&self) -> bool

Returns true if this address is an IPv4 address reserved by IANA for future use. RFC 1112 defines the block of reserved addresses as 240.0.0.0/4. This range normally includes the broadcast address 255.255.255.255, but this implementation explicitly excludes it, since it is obviously not reserved for future use. Read more
Source§

fn is_shared(&self) -> bool

Returns true if this address is part of the IPv4 Shared Address Space defined in RFC 6598 (100.64.0.0/10). Read more
Source§

fn is_thisnet(&self) -> bool

Returns true if this address is part of the IPv4 “This network” prefix defined in RFC 791 (0.0.0.0/8). Read more
Source§

fn is_benchmarking(&self) -> bool

Returns true if this is an address reserved for network device benchmarking: Read more
Source§

fn is_documentation(&self) -> bool

Returns true if this is an address reserved for documentation: Read more
Source§

fn is_global(&self) -> bool

Returns true if this address appears to be globally reachable. Read more
Source§

fn is_loopback(&self) -> bool

Returns true if this is a loopback address. Read more
Source§

fn is_multicast(&self) -> bool

Returns true if this is a multicast address. Read more
Source§

fn is_unspecified(&self) -> bool

Returns true for the special “unspecified” address, also called “this host on this network” in IPv4. Read more
Source§

fn is_unique_local(&self) -> bool

Returns true if this is an IPv6 unique local address (fc00::/7 RFC 4193). Read more
Source§

fn is_unicast(&self) -> bool

Returns true if this is neither a multicase nor a broadcast address. See is_multicast() and is_broadcast(). Read more
Source§

fn is_unicast_global(&self) -> bool

Returns true if this is a unicast address that is gloablly routable. See is_unicast() and is_global(). Read more
Source§

impl<A> Arbitrary for Address<A>
where A: Afi + 'static, A::Primitive: Arbitrary + 'static, StrategyFor<A::Primitive>: 'static,

Available on crate feature arbitrary only.
Source§

type Parameters = <<A as Afi>::Primitive as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
Source§

type Strategy = BoxedStrategy<Address<A>>

The type of Strategy used to generate values of type Self.
Source§

fn arbitrary_with(params: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
Source§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
Source§

impl<A: Afi, T: Type> BitAnd<Mask<T, A>> for Address<A>

Source§

type Output = Address<A>

The resulting type after applying the & operator.
Source§

fn bitand(self, mask: Mask<T, A>) -> Self::Output

Performs the & operation. Read more
Source§

impl<A: Afi, T> BitAndAssign<T> for Address<A>
where Self: BitAnd<T, Output = Self>,

Source§

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation. Read more
Source§

impl<A: Afi, T: Type> BitOr<Mask<T, A>> for Address<A>

Source§

type Output = Address<A>

The resulting type after applying the | operator.
Source§

fn bitor(self, mask: Mask<T, A>) -> Self::Output

Performs the | operation. Read more
Source§

impl<A: Afi> BitXor for Address<A>

Source§

type Output = <A as Afi>::Primitive

The resulting type after applying the ^ operator.
Source§

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation. Read more
Source§

impl<A: Clone + Afi> Clone for Address<A>
where A::Primitive: Clone,

Source§

fn clone(&self) -> Address<A>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Afi> Debug for Address<A>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A: Default + Afi> Default for Address<A>
where A::Primitive: Default,

Source§

fn default() -> Address<A>

Returns the “default value” for a type. Read more
Source§

impl<A: Afi> Display for Address<A>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<<Ipv4 as Afi>::Primitive> for Address<Ipv4>

Source§

fn from(primitive: <Ipv4 as Afi>::Primitive) -> Self

Converts to this type from the input type.
Source§

impl From<<Ipv6 as Afi>::Primitive> for Address<Ipv6>

Source§

fn from(primitive: <Ipv6 as Afi>::Primitive) -> Self

Converts to this type from the input type.
Source§

impl From<[u16; 8]> for Address<Ipv6>

Source§

fn from(segments: [u16; 8]) -> Self

Converts to this type from the input type.
Source§

impl<A: Afi> From<Address<A>> for Interface<A>

Source§

fn from(addr: Address<A>) -> Self

Converts to this type from the input type.
Source§

impl<A: Afi> From<Address<A>> for Bitmask<A>

Source§

fn from(addr: Address<A>) -> Self

Converts to this type from the input type.
Source§

impl<A: Afi> From<Address<A>> for Prefix<A>

Source§

fn from(addr: Address<A>) -> Self

Converts to this type from the input type.
Source§

impl From<Address<Ipv4>> for Address

Source§

fn from(addr: Address<Ipv4>) -> Self

Converts to this type from the input type.
Source§

impl From<Address<Ipv6>> for Address

Source§

fn from(addr: Address<Ipv6>) -> Self

Converts to this type from the input type.
Source§

impl From<Ipv4Addr> for Address<Ipv4>

Available on crate feature std only.
Source§

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.
Source§

impl From<Ipv6Addr> for Address<Ipv6>

Available on crate feature std only.
Source§

fn from(addr: Ipv6Addr) -> Self

Converts to this type from the input type.
Source§

impl<A, O> From<O> for Address<A>
where A: Afi<Octets = O>, O: Borrow<[u8]>,

Source§

fn from(octets: O) -> Self

Converts to this type from the input type.
Source§

impl<A: Afi> FromStr for Address<A>

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl<A: Hash + Afi> Hash for Address<A>
where A::Primitive: Hash,

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<A: Ord + Afi> Ord for Address<A>
where A::Primitive: Ord,

Source§

fn cmp(&self, other: &Address<A>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<A: Afi> PartialEq<Address<A>> for Prefix<A>

Source§

fn eq(&self, other: &Address<A>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<Address<Ipv4>> for Address

Source§

fn eq(&self, other: &Address<Ipv4>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<Address<Ipv6>> for Address

Source§

fn eq(&self, other: &Address<Ipv6>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<Address> for Address<Ipv4>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<Address> for Address<Ipv6>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<A: PartialEq + Afi> PartialEq for Address<A>
where A::Primitive: PartialEq,

Source§

fn eq(&self, other: &Address<A>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<A: Afi> PartialOrd<Address<A>> for Prefix<A>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PartialOrd<Address<Ipv4>> for Address

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PartialOrd<Address<Ipv6>> for Address

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PartialOrd<Address> for Address<Ipv4>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PartialOrd<Address> for Address<Ipv6>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<A: PartialOrd + Afi> PartialOrd for Address<A>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a> TryFrom<&'a [u8]> for Address<Ipv4>

Source§

type Error = <<Ipv4 as Afi>::Octets as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.
Source§

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<'a> TryFrom<&'a [u8]> for Address<Ipv6>

Source§

type Error = <<Ipv6 as Afi>::Octets as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.
Source§

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Address> for Address<Ipv4>

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(from: Address) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Address> for Address<Ipv6>

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(from: Address) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<A: Copy + Afi> Copy for Address<A>
where A::Primitive: Copy,

Source§

impl<A: Eq + Afi> Eq for Address<A>
where A::Primitive: Eq,

Source§

impl<A: Afi> StructuralPartialEq for Address<A>

Auto Trait Implementations§

§

impl<A> Freeze for Address<A>
where <A as Afi>::Primitive: Freeze,

§

impl<A> RefUnwindSafe for Address<A>
where <A as Afi>::Primitive: RefUnwindSafe,

§

impl<A> Send for Address<A>
where <A as Afi>::Primitive: Send,

§

impl<A> Sync for Address<A>
where <A as Afi>::Primitive: Sync,

§

impl<A> Unpin for Address<A>
where <A as Afi>::Primitive: Unpin,

§

impl<A> UnwindSafe for Address<A>
where <A as Afi>::Primitive: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V