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
impl ProxyQueryConnection
Sourcepub async fn connect(
endpoint: &ProxyEndpoint,
advertisement: Option<Vec<u8>>,
authority: Arc<QueryAuthority>,
connection_limits: QueryExecutionResourceLimits,
answer_limits: QueryExecutionResourceLimits,
cancellation: &AnswerCancellation,
) -> Result<Self, SdkExecutionDiagnostic>
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.
Sourcepub fn with_exchange(
advertisement: Vec<u8>,
authority: Arc<QueryAuthority>,
answer_limits: QueryExecutionResourceLimits,
) -> Result<Self, SdkExecutionDiagnostic>
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.
Sourcepub fn new(
http: Option<ProxyHttpTransport>,
advertisement: Vec<u8>,
authority: Arc<QueryAuthority>,
answer_limits: QueryExecutionResourceLimits,
) -> Result<Self, SdkExecutionDiagnostic>
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.
Sourcepub fn with_staged_advertisement(
self,
staged_advertisement: Vec<u8>,
) -> Result<Self, SdkExecutionDiagnostic>
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.
Sourcepub fn staged_advertisement(&self) -> Option<Arc<[u8]>>
pub fn staged_advertisement(&self) -> Option<Arc<[u8]>>
The staged advertisement pinned or verified on this connection.
Sourcepub const fn answer_limits(&self) -> QueryExecutionResourceLimits
pub const fn answer_limits(&self) -> QueryExecutionResourceLimits
The ceiling every terminal on this connection is constrained by.
Sourcepub async fn staged_transaction(
&self,
options: TransactionOptions,
cancellation: &AnswerCancellation,
) -> Result<Transaction, SdkExecutionDiagnostic>
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.
Sourcepub fn staged_transaction_with_exchange(
&self,
staged_advertisement: &[u8],
exchange: StagedExchangeFn,
options: TransactionOptions,
) -> Result<Transaction, SdkExecutionDiagnostic>
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.
Sourcepub const fn has_built_in_route(&self) -> bool
pub const fn has_built_in_route(&self) -> bool
Whether terminals reach the server through the built-in HTTP route.
Sourcepub fn prepare(
&self,
registry: &DescriptorRegistry,
validated: ValidatedMatchRequest,
resources: QueryExecutionResourceLimits,
cancellation: &AnswerCancellation,
deadline: QueryExecutionDeadline,
) -> Result<PendingRemoteModelQueryV2, QueryTargetError>
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.
Sourcepub fn finish(
pending: &PendingRemoteModelQueryV2,
response: &[u8],
cancellation: &AnswerCancellation,
deadline: QueryExecutionDeadline,
) -> Result<(ValidatedMatchRequest, ValidatedMatchResult), QueryTargetError>
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§
Auto Trait Implementations§
impl !Freeze for ProxyQueryConnection
impl !RefUnwindSafe for ProxyQueryConnection
impl !UnwindSafe for ProxyQueryConnection
impl Send for ProxyQueryConnection
impl Sync for ProxyQueryConnection
impl Unpin for ProxyQueryConnection
impl UnsafeUnpin for ProxyQueryConnection
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request