Struct SocketAddrV6

pub struct SocketAddrV6 {
    ip: Ipv6Addr,
    port: u16,
    flowinfo: u32,
    scope_id: u32,
}

An IPv6 socket address.

IPv6 socket addresses consist of an IPv6 address, a 16-bit port number, as well as fields containing the traffic class, the flow label, and a scope identifier (see IETF RFC 2553, Section 3.3 for more details).

See SocketAddr for a type encompassing both IPv4 and IPv6 socket addresses.

Portability

SocketAddrV6 is intended to be a portable representation of socket addresses and is likely not the same as the internal socket address type used by the target operating system’s API. Like all repr(Rust) structs, however, its exact layout remains undefined and should not be relied upon between builds.

Textual representation

SocketAddrV6 provides a FromStr implementation, based on the bracketed format recommended by IETF RFC 5952, with scope identifiers based on those specified in IETF RFC 4007.

It accepts addresses consisting of the following elements, in order:

• A left square bracket ([)
• The textual representation of an IPv6 address
• Optionally, a percent sign (%) followed by the scope identifier encoded as a decimal integer
• A right square bracket (])
• A colon (:)
• The port, encoded as a decimal integer.

For example, the string [2001:db8::413]:443 represents a SocketAddrV6 with the address 2001:db8::413 and port 443. The string [2001:db8::413%612]:443 represents the same address and port, with a scope identifier of 612.

Other formats are not accepted.

Examples

use std::net::{Ipv6Addr, SocketAddrV6};

let socket = SocketAddrV6::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1), 8080, 0, 0);

assert_eq!("[2001:db8::1]:8080".parse(), Ok(socket));
assert_eq!(socket.ip(), &Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1));
assert_eq!(socket.port(), 8080);

let mut with_scope = socket.clone();
with_scope.set_scope_id(3);
assert_eq!("[2001:db8::1%3]:8080".parse(), Ok(with_scope));

Fields

ip: Ipv6Addr

port: u16

flowinfo: u32

scope_id: u32

Implementations

impl SocketAddrV6

pub fn parse_ascii(b: &[u8]) -> Result<SocketAddrV6, AddrParseError>

🔬This is a nightly-only experimental API. (addr_parse_ascii)

Parse an IPv6 socket address from a slice of bytes.

#![feature(addr_parse_ascii)]

use std::net::{Ipv6Addr, SocketAddrV6};

let socket = SocketAddrV6::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1), 8080, 0, 0);

assert_eq!(SocketAddrV6::parse_ascii(b"[2001:db8::1]:8080"), Ok(socket));

impl SocketAddrV6

pub const fn new( ip: Ipv6Addr, port: u16, flowinfo: u32, scope_id: u32, ) -> SocketAddrV6

Creates a new socket address from an IPv6 address, a 16-bit port number, and the flowinfo and scope_id fields.

For more information on the meaning and layout of the flowinfo and scope_id parameters, see IETF RFC 2553, Section 3.3.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);

pub const fn ip(&self) -> &Ipv6Addr

Returns the IP address associated with this socket address.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
assert_eq!(socket.ip(), &Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));

pub const fn set_ip(&mut self, new_ip: Ipv6Addr)

Changes the IP address associated with this socket address.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
socket.set_ip(Ipv6Addr::new(76, 45, 0, 0, 0, 0, 0, 0));
assert_eq!(socket.ip(), &Ipv6Addr::new(76, 45, 0, 0, 0, 0, 0, 0));

pub const fn port(&self) -> u16

Returns the port number associated with this socket address.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
assert_eq!(socket.port(), 8080);

pub const fn set_port(&mut self, new_port: u16)

Changes the port number associated with this socket address.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
socket.set_port(4242);
assert_eq!(socket.port(), 4242);

pub const fn flowinfo(&self) -> u32

Returns the flow information associated with this address.

This information corresponds to the sin6_flowinfo field in C’s netinet/in.h, as specified in IETF RFC 2553, Section 3.3. It combines information about the flow label and the traffic class as specified in IETF RFC 2460, respectively Section 6 and Section 7.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0);
assert_eq!(socket.flowinfo(), 10);

pub const fn set_flowinfo(&mut self, new_flowinfo: u32)

Changes the flow information associated with this socket address.

See SocketAddrV6::flowinfo’s documentation for more details.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0);
socket.set_flowinfo(56);
assert_eq!(socket.flowinfo(), 56);

pub const fn scope_id(&self) -> u32

Returns the scope ID associated with this address.

This information corresponds to the sin6_scope_id field in C’s netinet/in.h, as specified in IETF RFC 2553, Section 3.3.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 78);
assert_eq!(socket.scope_id(), 78);

pub const fn set_scope_id(&mut self, new_scope_id: u32)

Changes the scope ID associated with this socket address.

See SocketAddrV6::scope_id’s documentation for more details.

Examples

use std::net::{SocketAddrV6, Ipv6Addr};

let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 78);
socket.set_scope_id(42);
assert_eq!(socket.scope_id(), 42);

Trait Implementations

impl<'a> AddAnyAttr for SocketAddrV6

type Output<SomeNewAttr: Attribute> = SocketAddrV6

The new type once the attribute has been added.

fn add_any_attr<NewAttr>( self, _attr: NewAttr, ) -> <SocketAddrV6 as AddAnyAttr>::Output<NewAttr>

where NewAttr: Attribute,

Adds an attribute to the view.

impl Archive for SocketAddrV6

type Archived = ArchivedSocketAddrV6

The archived representation of this type.

type Resolver = ()

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, _: <SocketAddrV6 as Archive>::Resolver, out: *mut <SocketAddrV6 as Archive>::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl AttributeValue for SocketAddrV6

type AsyncOutput = SocketAddrV6

The type once all async data have loaded.

type State = (Element, SocketAddrV6)

The state that should be retained between building and rebuilding.

type Cloneable = SocketAddrV6

A version of the value that can be cloned. This can be the same type, or a reference-counted type. Generally speaking, this does not need to refer to the same data, but should behave in the same way. So for example, making an event handler cloneable should probably make it reference-counted (so that a FnMut() continues mutating the same closure), but making a String cloneable does not necessarily need to make it an Arc<str>, as two different clones of a String will still have the same value.

type CloneableOwned = SocketAddrV6

A cloneable type that is also 'static. This is used for spreading across types when the spreadable attribute needs to be owned. In some cases (&'a str to Arc<str>, etc.) the owned cloneable type has worse performance than the cloneable type, so they are separate.

fn html_len(&self) -> usize

An approximation of the actual length of this attribute in HTML.

fn to_html(self, key: &str, buf: &mut String)

Renders the attribute value to HTML.

fn to_template(_key: &str, _buf: &mut String)

Renders the attribute value to HTML for a <template>.

fn hydrate<const FROM_SERVER: bool>( self, key: &str, el: &Element, ) -> <SocketAddrV6 as AttributeValue>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.

fn build( self, el: &Element, key: &str, ) -> <SocketAddrV6 as AttributeValue>::State

Adds this attribute to the element during client-side rendering.

fn rebuild(self, key: &str, state: &mut <SocketAddrV6 as AttributeValue>::State)

Applies a new value for the attribute.

fn into_cloneable(self) -> <SocketAddrV6 as AttributeValue>::Cloneable

Converts this attribute into an equivalent that can be cloned.

fn into_cloneable_owned( self, ) -> <SocketAddrV6 as AttributeValue>::CloneableOwned

Converts this attributes into an equivalent that can be cloned and is 'static.

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <SocketAddrV6 as AttributeValue>::AsyncOutput

“Resolves” this into a form that is not waiting for any asynchronous data.

impl<'de, __Context> BorrowDecode<'de, __Context> for SocketAddrV6

fn borrow_decode<D>(decoder: &mut D) -> Result<SocketAddrV6, DecodeError>

where D: BorrowDecoder<'de, Context = __Context>,

Attempt to decode this type with the given BorrowDecode.

impl Clone for SocketAddrV6

fn clone(&self) -> SocketAddrV6

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketAddrV6

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

Formats the value using the given formatter.

impl<Context> Decode<Context> for SocketAddrV6

fn decode<D>(decoder: &mut D) -> Result<SocketAddrV6, DecodeError>

where D: Decoder<Context = Context>,

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for SocketAddrV6

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SocketAddrV6

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

Formats the value using the given formatter.

impl Encode for SocketAddrV6

fn encode<E>(&self, encoder: &mut E) -> Result<(), EncodeError>

where E: Encoder,

Encode a given type.

impl From<SocketAddrV6> for SockAddr

fn from(addr: SocketAddrV6) -> SockAddr

Converts to this type from the input type.

impl From<SocketAddrV6> for SocketAddr

fn from(sock6: SocketAddrV6) -> SocketAddr

Converts a SocketAddrV6 into a SocketAddr::V6.

impl From<SocketAddrV6> for SocketAddrAny

fn from(from: SocketAddrV6) -> SocketAddrAny

Converts to this type from the input type.

impl FromStr for SocketAddrV6

type Err = AddrParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SocketAddrV6, AddrParseError>

Parses a string s to return a value of this type.

impl Hash for SocketAddrV6

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SocketAddrV6

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<ArchivedSocketAddrV6> for SocketAddrV6

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<SocketAddrV6> for ArchivedSocketAddrV6

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for SocketAddrV6

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<ArchivedSocketAddrV6> for SocketAddrV6

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<SocketAddrV6> for ArchivedSocketAddrV6

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd for SocketAddrV6

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PatchField for SocketAddrV6

fn patch_field( &mut self, new: SocketAddrV6, path: &StorePath, notify: &mut dyn FnMut(&StorePath), )

Patches the field with some new value, only notifying if the value has changed.

impl Render for SocketAddrV6

type State = SocketAddrV6State

The “view state” for this type, which can be retained between updates.

fn build(self) -> <SocketAddrV6 as Render>::State

Creates the view for the first time, without hydrating from existing HTML.

fn rebuild(self, state: &mut <SocketAddrV6 as Render>::State)

Updates the view with new data.

impl RenderHtml for SocketAddrV6

const MIN_LENGTH: usize = 0usize

The minimum length of HTML created when this view is rendered.

type AsyncOutput = SocketAddrV6

The type of the view after waiting for all asynchronous data to load.

type Owned = SocketAddrV6

An equivalent value that is 'static.

fn dry_resolve(&mut self)

“Runs” the view without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <SocketAddrV6 as RenderHtml>::AsyncOutput

Waits for any asynchronous sections of the view to load and returns the output.

fn to_html_with_buf( self, buf: &mut String, position: &mut Position, _escape: bool, _mark_branches: bool, _extra_attrs: Vec<AnyAttribute>, )

Renders a view to HTML, writing it into the given buffer.

fn hydrate<const FROM_SERVER: bool>( self, cursor: &Cursor, position: &PositionState, ) -> <SocketAddrV6 as Render>::State

Makes a set of DOM nodes rendered from HTML interactive.

fn into_owned(self) -> <SocketAddrV6 as RenderHtml>::Owned

Convert into the equivalent value that is 'static.

const EXISTS: bool = true

Whether this should actually exist in the DOM, if it is the child of an element.

fn html_len(&self) -> usize

An estimated length for this view, when rendered to HTML.

fn to_html(self) -> String

where Self: Sized,

Renders a view to an HTML string.

fn to_html_branching(self) -> String

where Self: Sized,

Renders a view to HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_stream_in_order(self) -> StreamBuilder

where Self: Sized,

Renders a view to an in-order stream of HTML.

fn to_html_stream_in_order_branching(self) -> StreamBuilder

where Self: Sized,

Renders a view to an in-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_stream_out_of_order(self) -> StreamBuilder

where Self: Sized,

Renders a view to an out-of-order stream of HTML.

fn to_html_stream_out_of_order_branching(self) -> StreamBuilder

where Self: Sized,

Renders a view to an out-of-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_async_with_buf<const OUT_OF_ORDER: bool>( self, buf: &mut StreamBuilder, position: &mut Position, escape: bool, mark_branches: bool, extra_attrs: Vec<AnyAttribute>, )

where Self: Sized,

Renders a view into a buffer of (synchronous or asynchronous) HTML chunks.

fn hydrate_async( self, cursor: &Cursor, position: &PositionState, ) -> impl Future<Output = Self::State>

Asynchronously makes a set of DOM nodes rendered from HTML interactive.

fn hydrate_from<const FROM_SERVER: bool>(self, el: &Element) -> Self::State

where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element.

fn hydrate_from_position<const FROM_SERVER: bool>( self, el: &Element, position: Position, ) -> Self::State

where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element and position.

impl<S> Serialize<S> for SocketAddrV6

where S: Fallible + ?Sized,

fn serialize( &self, _: &mut S, ) -> Result<<SocketAddrV6 as Archive>::Resolver, <S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for SocketAddrV6

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SocketAddrArg for SocketAddrV6

unsafe fn with_sockaddr<R>( &self, f: impl FnOnce(*const SocketAddrOpaque, u32) -> R, ) -> R

Call a closure with the pointer and length to the corresponding C type.

fn as_any(&self) -> SocketAddrAny

Convert to SocketAddrAny.

unsafe fn write_sockaddr(&self, storage: *mut SocketAddrStorage) -> u32

Encode an address into a SocketAddrStorage.

impl ToSocketAddrs for SocketAddrV6

type Iter = IntoIter<SocketAddr>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, Error>

Converts this object to an iterator of resolved SocketAddrs.

impl<'a> ToTemplate for SocketAddrV6

const TEMPLATE: &'static str = " <!>"

The HTML content of the static template.

fn to_template( buf: &mut String, _class: &mut String, _style: &mut String, _inner_html: &mut String, position: &mut Position, )

Renders a view type to a template. This does not take actual view data, but can be used for constructing part of an HTML <template> that corresponds to a view of a particular type.

const CLASS: &'static str = ""

The class attribute content known at compile time.

const STYLE: &'static str = ""

The style attribute content known at compile time.

const LEN: usize = _

The length of the template.

fn to_template_attribute( buf: &mut String, class: &mut String, style: &mut String, inner_html: &mut String, position: &mut Position, )

Renders a view type to a template in attribute position.

impl TryFrom<SocketAddrAny> for SocketAddrV6

fn try_from( value: SocketAddrAny, ) -> Result<SocketAddrV6, <SocketAddrV6 as TryFrom<SocketAddrAny>>::Error>

Convert if the address is an IPv6 address.

Returns Err(Errno::AFNOSUPPORT) if the address family is not IPv6.

type Error = Errno

The type returned in the event of a conversion error.

impl Copy for SocketAddrV6

impl Eq for SocketAddrV6

impl StructuralPartialEq for SocketAddrV6

impl ToSocketAddrs for SocketAddrV6