Enum Interface

pub enum Interface {
    Address(SocketAddress),
    Device(DeviceName),
    Socket(Arc<SocketOptions>),
}
Expand description

The interface to bind a Socket to.

Variants§

§

Address(SocketAddress)

Bind to a Socket address (ip + port), the most common choice

§

Device(DeviceName)

Bind to a network device interface name, using IPv4/TCP.

Use SocketOptions if you want more finegrained control, or make a raw Socket yourself.

§

Socket(Arc<SocketOptions>)

Bind to a socket with the following options.

Implementations§

§

impl Interface

pub fn new_address(addr: impl Into<SocketAddress>) -> Interface

creates a new Interface from a SocketAddress

§

impl Interface

pub const fn new_device(name: &'static str) -> Interface

§

impl Interface

pub const fn local_ipv4(port: u16) -> Interface

creates a new local ipv4 Interface for the given port

§Example
use rama_net::socket::Interface;

let interface = Interface::local_ipv4(8080);
assert_eq!("127.0.0.1:8080", interface.to_string());

pub const fn local_ipv6(port: u16) -> Interface

creates a new local ipv6 Interface for the given port.

§Example
use rama_net::socket::Interface;

let interface = Interface::local_ipv6(8080);
assert_eq!("[::1]:8080", interface.to_string());

pub const fn default_ipv4(port: u16) -> Interface

creates a new default ipv4 Interface for the given port

§Example
use rama_net::socket::Interface;

let interface = Interface::default_ipv4(8080);
assert_eq!("0.0.0.0:8080", interface.to_string());

pub const fn default_ipv6(port: u16) -> Interface

creates a new default ipv6 Interface for the given port.

§Example
use rama_net::socket::Interface;

let interface = Interface::default_ipv6(8080);
assert_eq!("[::]:8080", interface.to_string());

pub const fn broadcast_ipv4(port: u16) -> Interface

creates a new broadcast ipv4 Interface for the given port

§Example
use rama_net::socket::Interface;

let interface = Interface::broadcast_ipv4(8080);
assert_eq!("255.255.255.255:8080", interface.to_string());

Trait Implementations§

§

impl Clone for Interface

§

fn clone(&self) -> Interface

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
§

impl Debug for Interface

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for Interface

§

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

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for Interface

§

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

Formats the value using the given formatter. Read more
§

impl From<&SocketAddr> for Interface

§

fn from(addr: &SocketAddr) -> Interface

Converts to this type from the input type.
§

impl From<&SocketAddress> for Interface

§

fn from(addr: &SocketAddress) -> Interface

Converts to this type from the input type.
§

impl From<([u8; 16], u16)> for Interface

§

fn from(twin: ([u8; 16], u16)) -> Interface

Converts to this type from the input type.
§

impl From<([u8; 4], u16)> for Interface

§

fn from(twin: ([u8; 4], u16)) -> Interface

Converts to this type from the input type.
§

impl From<(IpAddr, u16)> for Interface

§

fn from(twin: (IpAddr, u16)) -> Interface

Converts to this type from the input type.
§

impl From<(Ipv4Addr, u16)> for Interface

§

fn from(twin: (Ipv4Addr, u16)) -> Interface

Converts to this type from the input type.
§

impl From<(Ipv6Addr, u16)> for Interface

§

fn from(twin: (Ipv6Addr, u16)) -> Interface

Converts to this type from the input type.
§

impl From<Arc<SocketOptions>> for Interface

§

fn from(value: Arc<SocketOptions>) -> Interface

Converts to this type from the input type.
§

impl From<SocketAddr> for Interface

§

fn from(addr: SocketAddr) -> Interface

Converts to this type from the input type.
§

impl From<SocketAddrV4> for Interface

§

fn from(addr: SocketAddrV4) -> Interface

Converts to this type from the input type.
§

impl From<SocketAddrV6> for Interface

§

fn from(addr: SocketAddrV6) -> Interface

Converts to this type from the input type.
§

impl From<SocketAddress> for Interface

§

fn from(addr: SocketAddress) -> Interface

Converts to this type from the input type.
§

impl From<SocketOptions> for Interface

§

fn from(value: SocketOptions) -> Interface

Converts to this type from the input type.
§

impl FromStr for Interface

§

type Err = OpaqueError

The associated error which can be returned from parsing.
§

fn from_str(s: &str) -> Result<Interface, <Interface as FromStr>::Err>

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

impl Serialize for Interface

§

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. Read more
§

impl Service<Interface> for DefaultAcceptorFactory

§

type Response = (TcpListener, Context)

The type of response returned by the service.
§

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.
§

async fn serve( &self, ctx: Context, interface: Interface, ) -> Result<<DefaultAcceptorFactory as Service<Interface>>::Response, <DefaultAcceptorFactory as Service<Interface>>::Error>

Serve a response or error for the given request, using the given context.
§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.
§

impl Service<Interface> for DefaultUdpBinder

§

type Response = (UdpSocket, Context)

The type of response returned by the service.
§

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.
§

async fn serve( &self, ctx: Context, interface: Interface, ) -> Result<<DefaultUdpBinder as Service<Interface>>::Response, <DefaultUdpBinder as Service<Interface>>::Error>

Serve a response or error for the given request, using the given context.
§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.
§

impl TryFrom<&[u8]> for Interface

§

type Error = OpaqueError

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

fn try_from( bytes: &[u8], ) -> Result<Interface, <Interface as TryFrom<&[u8]>>::Error>

Performs the conversion.
§

impl TryFrom<&String> for Interface

§

type Error = OpaqueError

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

fn try_from( value: &String, ) -> Result<Interface, <Interface as TryFrom<&String>>::Error>

Performs the conversion.
§

impl TryFrom<&str> for Interface

§

type Error = OpaqueError

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

fn try_from(s: &str) -> Result<Interface, <Interface as TryFrom<&str>>::Error>

Performs the conversion.
§

impl TryFrom<String> for Interface

§

type Error = OpaqueError

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

fn try_from( s: String, ) -> Result<Interface, <Interface as TryFrom<String>>::Error>

Performs the conversion.
§

impl TryFrom<Vec<u8>> for Interface

§

type Error = OpaqueError

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

fn try_from( bytes: Vec<u8>, ) -> Result<Interface, <Interface as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

Auto Trait Implementations§

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

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

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

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

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
§

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

§

fn to_smolstr(&self) -> SmolStr

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
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,