Skip to main content

StreamForwardService

Struct StreamForwardService

pub struct StreamForwardService { /* private fields */ }

Expand description

A Service which takes a StreamBridge and pumps frames between the two endpoints bidirectionally.

The service optionally observes a ShutdownGuard (for graceful termination) and an idle timeout that closes the bridge when no frame has been forwarded in either direction within the configured window.

Returns a BridgeCloseReason describing why the bridge ended.

Implementations§

impl StreamForwardService

pub fn new() -> StreamForwardService

Create a new StreamForwardService with no idle timeout and no shutdown guard. Equivalent to StreamForwardService::default.

pub fn maybe_with_idle_timeout( self, timeout: Option<Duration>, ) -> StreamForwardService

Idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no frame has been forwarded in either direction within timeout.

None (the default) disables idle detection.

pub fn maybe_set_idle_timeout( &mut self, timeout: Option<Duration>, ) -> &mut StreamForwardService

Idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no frame has been forwarded in either direction within timeout.

None (the default) disables idle detection.

pub fn with_idle_timeout(self, timeout: Duration) -> StreamForwardService

Idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no frame has been forwarded in either direction within timeout.

None (the default) disables idle detection.

pub fn set_idle_timeout( &mut self, timeout: Duration, ) -> &mut StreamForwardService

Idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no frame has been forwarded in either direction within timeout.

None (the default) disables idle detection.

pub fn without_idle_timeout(self) -> StreamForwardService

Idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no frame has been forwarded in either direction within timeout.

None (the default) disables idle detection.

pub fn unset_idle_timeout(&mut self) -> &mut StreamForwardService

Idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no frame has been forwarded in either direction within timeout.

None (the default) disables idle detection.

pub fn maybe_with_shutdown_guard( self, guard: Option<ShutdownGuard>, ) -> StreamForwardService

ShutdownGuard used to observe graceful-shutdown signals. When the guard fires, the bridge closes with reason BridgeCloseReason::Shutdown.

None (the default) means no shutdown observation.

pub fn maybe_set_shutdown_guard( &mut self, guard: Option<ShutdownGuard>, ) -> &mut StreamForwardService

ShutdownGuard used to observe graceful-shutdown signals. When the guard fires, the bridge closes with reason BridgeCloseReason::Shutdown.

None (the default) means no shutdown observation.

pub fn with_shutdown_guard(self, guard: ShutdownGuard) -> StreamForwardService

ShutdownGuard used to observe graceful-shutdown signals. When the guard fires, the bridge closes with reason BridgeCloseReason::Shutdown.

None (the default) means no shutdown observation.

pub fn set_shutdown_guard( &mut self, guard: ShutdownGuard, ) -> &mut StreamForwardService

ShutdownGuard used to observe graceful-shutdown signals. When the guard fires, the bridge closes with reason BridgeCloseReason::Shutdown.

None (the default) means no shutdown observation.

pub fn without_shutdown_guard(self) -> StreamForwardService

ShutdownGuard used to observe graceful-shutdown signals. When the guard fires, the bridge closes with reason BridgeCloseReason::Shutdown.

None (the default) means no shutdown observation.

pub fn unset_shutdown_guard(&mut self) -> &mut StreamForwardService

ShutdownGuard used to observe graceful-shutdown signals. When the guard fires, the bridge closes with reason BridgeCloseReason::Shutdown.

None (the default) means no shutdown observation.

Trait Implementations§

impl Clone for StreamForwardService

fn clone(&self) -> StreamForwardService

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for StreamForwardService

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

Formats the value using the given formatter. Read more

impl Default for StreamForwardService

fn default() -> StreamForwardService

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

impl<A, B, T, EA, EB> Service<StreamBridge<A, B>> for StreamForwardService
where A: Stream<Item = Result<T, EA>> + Sink<T, Error = EA> + Send + Unpin + 'static, B: Stream<Item = Result<T, EB>> + Sink<T, Error = EB> + Send + Unpin + 'static, T: Send + 'static, EA: Into<Box<dyn Error + Send + Sync>> + Send + 'static, EB: Into<Box<dyn Error + Send + Sync>> + Send + 'static,

type Output = BridgeCloseReason

The type of the output returned by the service.

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

The type of error returned by the service.

async fn serve( &self, bridge: StreamBridge<A, B>, ) -> Result<<StreamForwardService as Service<StreamBridge<A, B>>>::Output, <StreamForwardService as Service<StreamBridge<A, B>>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

impl Freeze for StreamForwardService

impl RefUnwindSafe for StreamForwardService

impl Send for StreamForwardService

impl Sync for StreamForwardService

impl Unpin for StreamForwardService

impl UnsafeUnpin for StreamForwardService

impl UnwindSafe for StreamForwardService

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

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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, 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<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

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