rama::net::forwarded

Struct Forwarded

pub struct Forwarded { /* private fields */ }

Expand description

Forwarding information stored as a chain.

This extension (which can be stored and modified via the Context) allows to keep track of the forward information. E.g. what was the original host used by the user, by which proxy it was forwarded, what was the intended protocol (e.g. https), etc…

RFC: https://datatracker.ietf.org/doc/html/rfc7239

Implementations§

impl Forwarded

pub const fn new(element: ForwardedElement) -> Forwarded

Create a new Forwarded extension for the given ForwardedElement as the client Element (the first element).

pub fn client_host(&self) -> Option<&ForwardedAuthority>

Return the client host of this Forwarded context, if there is one defined.

It is assumed that only the first element can be described as client information.

pub fn client_socket_addr(&self) -> Option<SocketAddr>

Return the client SocketAddr of this Forwarded context, if both an Ip and a port are defined.

You can try to fallback to Self::client_ip, in case this method returns None.

pub fn client_port(&self) -> Option<u16>

Return the client port of this Forwarded context, if there is one defined.

pub fn client_ip(&self) -> Option<IpAddr>

Return the client Ip of this Forwarded context, if there is one defined.

This method may return None because there is no forwarded “for” information for the client element or because the IP is obfuscated.

It is assumed that only the first element can be described as client information.

pub fn client_proto(&self) -> Option<ForwardedProtocol>

Return the client protocol of this Forwarded context, if there is one defined.

pub fn client_version(&self) -> Option<ForwardedVersion>

Return the client protocol version of this Forwarded context, if there is one defined.

pub fn append(&mut self, element: ForwardedElement) -> &mut Forwarded

Append a ForwardedElement to this Forwarded context.

pub fn extend( &mut self, elements: impl IntoIterator<Item = ForwardedElement>, ) -> &mut Forwarded

Extend this Forwarded context with the given ForwardedElements.

pub fn iter(&self) -> impl Iterator<Item = &ForwardedElement>

Iterate over the ForwardedElements in this Forwarded context.

Trait Implementations§

impl Clone for Forwarded

fn clone(&self) -> Forwarded

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 Forwarded

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

Formats the value using the given formatter. Read more

impl Display for Forwarded

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

Formats the value using the given formatter. Read more

impl From<Forwarded> for Forwarded

fn from(value: Forwarded) -> Forwarded

Converts to this type from the input type.

impl From<Forwarded> for Forwarded

fn from(value: Forwarded) -> Forwarded

Converts to this type from the input type.

impl From<ForwardedElement> for Forwarded

fn from(value: ForwardedElement) -> Forwarded

Converts to this type from the input type.

impl FromStr for Forwarded

type Err = OpaqueError

The associated error which can be returned from parsing.

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

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

impl IntoIterator for Forwarded

type Item = ForwardedElement

The type of the elements being iterated over.

type IntoIter = Chain<Once<ForwardedElement>, IntoIter<ForwardedElement>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Forwarded as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl PartialEq for Forwarded

fn eq(&self, other: &Forwarded) -> 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.

impl TryFrom<&[u8]> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&HeaderValue> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from( header: &HeaderValue, ) -> Result<Forwarded, <Forwarded as TryFrom<&HeaderValue>>::Error>

Performs the conversion.

impl TryFrom<&str> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<HeaderValue> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from( header: HeaderValue, ) -> Result<Forwarded, <Forwarded as TryFrom<HeaderValue>>::Error>

Performs the conversion.

impl TryFrom<String> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Forwarded

impl StructuralPartialEq for Forwarded

Auto Trait Implementations§

impl Freeze for Forwarded

impl RefUnwindSafe for Forwarded

impl Send for Forwarded

impl Sync for Forwarded

impl Unpin for Forwarded

impl UnwindSafe for Forwarded

Blanket Implementations§

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

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>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

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

fn rama_into(self) -> U

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

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

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

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