Enum TransportEvent 

#[non_exhaustive]
pub enum TransportEvent {
    Started,
    #[non_exhaustive]
    Succeeded {
        status: u16,
        ms: u64,
        bytes: Option<u64>,
    },
    #[non_exhaustive]
    Failed {
        error: ClientError,
        ms: u64,
    },
    Cancelled,
    #[non_exhaustive]
    RetryScheduled {
        after: Duration,
        attempt: usize,
    },
    #[non_exhaustive]
    BreakerOpened {
        cooldown: Duration,
    },
    BreakerClosed,
    #[non_exhaustive]
    RowsPulled {
        n: usize,
    },
    WritePushed,
}

One thing a client reports to its TransportObserver. New events may be added; match with a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Started

Once per attempt: immediately before the request is sent, or, for a fail-fast rejection, immediately before its Failed { ms: 0 }.

#[non_exhaustive]

Succeeded

One attempt got a 2xx. bytes is the Content-Length, when sent.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

status: u16

The HTTP status.

ms: u64

Milliseconds from sending to the response head.

bytes: Option<u64>

The response’s Content-Length, when the server sent one.

#[non_exhaustive]

Failed

One attempt failed. The last Failed of a call carries the error the call returns.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

error: ClientError

What went wrong in this attempt.

ms: u64

Milliseconds from sending to the failure; 0 when nothing was sent.

Cancelled

The call’s future was dropped after Started and before the attempt landed: the request is abandoned, and nothing is known about how the server would have answered.

#[non_exhaustive]

RetryScheduled

A retry will run after after; attempt is its 1-based number.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

after: Duration

The back-off before the retry.

attempt: usize

The retry’s 1-based number.

#[non_exhaustive]

BreakerOpened

The circuit breaker opened, or a half-open probe failed and it re-opened.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cooldown: Duration

How long it stays open before the next probe.

BreakerClosed

The circuit breaker closed again.

#[non_exhaustive]

RowsPulled

Reported by the caller once it has parsed a response.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

n: usize

Rows parsed from the response.

WritePushed

Reported by the caller once a write was acknowledged.

Implementations

impl TransportEvent

pub fn succeeded(status: u16, ms: u64, bytes: Option<u64>) -> TransportEvent

A Succeeded event.

pub fn failed(error: ClientError, ms: u64) -> TransportEvent

A Failed event.

pub fn retry_scheduled(after: Duration, attempt: usize) -> TransportEvent

A RetryScheduled event.

pub fn rows_pulled(n: usize) -> TransportEvent

A RowsPulled event.

pub fn breaker_opened(cooldown: Duration) -> TransportEvent

A BreakerOpened event.

Trait Implementations

impl Clone for TransportEvent

fn clone(&self) -> TransportEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransportEvent

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

Formats the value using the given formatter.