Skip to main content

ProxyQueryConnection

Struct ProxyQueryConnection 

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

A connection to a TypeBridge server: its verified advertisement, the schema authority requests are prepared under, the answer-limit ceiling, and the built-in HTTP route unless the caller owns the exchange.

Implementations§

Source§

impl ProxyQueryConnection

Source

pub async fn connect( endpoint: &ProxyEndpoint, advertisement: Option<Vec<u8>>, authority: Arc<QueryAuthority>, connection_limits: QueryExecutionResourceLimits, answer_limits: QueryExecutionResourceLimits, cancellation: &AnswerCancellation, ) -> Result<Self, SdkExecutionDiagnostic>

Open endpoint and fetch its advertisement, or use the pinned advertisement, then validate it.

connection_limits bounds the fetch; answer_limits is the ceiling every terminal on this connection is constrained by.

§Errors

Returns the endpoint, transport, interruption, or advertisement diagnostic.

Source

pub fn with_exchange( advertisement: Vec<u8>, authority: Arc<QueryAuthority>, answer_limits: QueryExecutionResourceLimits, ) -> Result<Self, SdkExecutionDiagnostic>

A connection whose exchange the caller performs: terminals run through Self::prepare and Self::finish instead of QueryTarget::execute.

§Errors

Returns the advertisement diagnostic.

Source

pub fn new( http: Option<ProxyHttpTransport>, advertisement: Vec<u8>, authority: Arc<QueryAuthority>, answer_limits: QueryExecutionResourceLimits, ) -> Result<Self, SdkExecutionDiagnostic>

A connection over an already opened route (or a caller-owned exchange when http is None) and an already fetched advertisement, which is validated here.

§Errors

Returns the advertisement diagnostic.

Source

pub fn with_staged_advertisement( self, staged_advertisement: Vec<u8>, ) -> Result<Self, SdkExecutionDiagnostic>

Pin the staged (GET /v3/capabilities) advertisement, provisioned out of band, so staged transactions never fetch it.

§Errors

Returns the decode failure, or query_remote_v3_advertisement_mismatch when its executor binding or reply key differs from this connection’s advertisement.

Source

pub fn staged_advertisement(&self) -> Option<Arc<[u8]>>

The staged advertisement pinned or verified on this connection.

Source

pub const fn answer_limits(&self) -> QueryExecutionResourceLimits

The ceiling every terminal on this connection is constrained by.

Source

pub async fn staged_transaction( &self, options: TransactionOptions, cancellation: &AnswerCancellation, ) -> Result<Transaction, SdkExecutionDiagnostic>

Open a staged transaction whose commit is one signed query-remote/v3 exchange through the built-in route. The staged advertisement is fetched from /v3/capabilities now; nothing else is sent until commit.

§Errors

Returns the provider failure when the connection has no built-in route or the advertisement cannot be fetched or decoded.

Source

pub fn staged_transaction_with_exchange( &self, staged_advertisement: &[u8], exchange: StagedExchangeFn, options: TransactionOptions, ) -> Result<Transaction, SdkExecutionDiagnostic>

Open a staged transaction over a caller-owned exchange: exchange sends the exact request bytes to /v3/staged and returns the exact reply bytes. staged_advertisement is the /v3/capabilities body; it must name this connection’s executor and reply key.

§Errors

Returns the decode failure of the advertisement, or query_remote_v3_advertisement_mismatch.

Source

pub const fn has_built_in_route(&self) -> bool

Whether terminals reach the server through the built-in HTTP route.

Source

pub fn prepare( &self, registry: &DescriptorRegistry, validated: ValidatedMatchRequest, resources: QueryExecutionResourceLimits, cancellation: &AnswerCancellation, deadline: QueryExecutionDeadline, ) -> Result<PendingRemoteModelQueryV2, QueryTargetError>

Prepare one request for a caller-owned exchange, with resources constrained by this connection’s ceiling. Send PendingRemoteModelQueryV2::request_bytes and pass the reply to Self::finish.

§Errors

Returns the interruption or preparation failure.

Source

pub fn finish( pending: &PendingRemoteModelQueryV2, response: &[u8], cancellation: &AnswerCancellation, deadline: QueryExecutionDeadline, ) -> Result<(ValidatedMatchRequest, ValidatedMatchResult), QueryTargetError>

Authenticate and validate the reply to a Self::prepared request.

§Errors

Returns the interruption, or the claim or reply failure.

Trait Implementations§

Source§

impl Debug for ProxyQueryConnection

Source§

fn fmt(&self, formatter: &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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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