Skip to main content

UdsRelay

Struct UdsRelay 

Source
pub struct UdsRelay { /* private fields */ }
Expand description

Console’s UDS client for one target.

Why: the dial half of ADR-0034’s relay. Since #5182 it can also START the target: with a supervisor attached it calls ensure_running before writing the frame, which is what lets the target stay non-resident. Without one it dials whatever is already at the path, which is what the tests and any externally-managed deployment want. What: a socket path, a timeout, and an optional supervisor. Cheap to clone; opens a fresh connection per delivery, matching every other UDS client in this workspace. Test: relay_* cases in webhook/tests.rs.

Implementations§

Source§

impl UdsRelay

Source

pub fn new(socket: impl Into<PathBuf>) -> Self

Target socket with DEFAULT_RELAY_TIMEOUT and no supervision.

Source

pub fn with_supervisor( self, source: impl Into<String>, supervisor: SharedSupervisor, ) -> Self

Start the target on demand, under supervisor, keyed by source.

Test: relay_with_a_supervisor_still_acks_against_a_live_target, spawn_adopts_a_socket_that_is_already_served.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Override the round-trip budget.

Source

pub fn socket(&self) -> &Path

Socket this relay dials.

Source

pub fn timeout(&self) -> Duration

Round-trip budget, which is also the sweep’s hands-off grace period for an entry the request path may still be relaying.

Source

pub async fn deliver(&self, entry: &SpoolEntry) -> RelayOutcome

Send one delivery and classify the answer.

Why: the classification is the whole safety property. Anything other than an explicit "ack": true leaves the entry pending, so a target that accepts a connection and then crashes, or answers with an empty object, does not cause the delivery to be dropped.

What: dials through the hardened UDS entry point, writes one frame, reads one frame, and defers the ack decision to RelayResponse::is_ack so both halves of the contract agree on it. A JSON-RPC error or a non-ack result is RelayOutcome::Refused; any transport failure is RelayOutcome::Unreachable.

Never returns Err: every failure is a first-class outcome the caller must record durably, and an error return invites the let _ = ADR-0034 §2 forbids.

Test: relay_acked_response_is_the_only_ack, relay_treats_a_result_without_ack_as_refused, relay_treats_a_jsonrpc_error_as_refused, relay_reports_unreachable_when_no_listener_is_bound, relay_reports_unreachable_when_the_target_hangs_up_without_answering.

Trait Implementations§

Source§

impl Clone for UdsRelay

Source§

fn clone(&self) -> UdsRelay

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

impl Debug for UdsRelay

Source§

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

Formats the value using the given formatter. Read more

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

Source§

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

Source§

fn from_ref(input: &T) -> T

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

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

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

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
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
Source§

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

Source§

type Error = !

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

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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