Enum glean_core::upload::UploadResult

pub enum UploadResult {
    RecoverableFailure { /* private fields */ },
    UnrecoverableFailure { /* private fields */ },
    Incapable { /* private fields */ },
    HttpStatus {
        code: i32,
    },
    Done { /* private fields */ },
}

The result of an attempted ping upload.

Variants

RecoverableFailure

A recoverable failure.

During upload something went wrong, e.g. the network connection failed. The upload should be retried at a later time.

UnrecoverableFailure

An unrecoverable upload failure.

A possible cause might be a malformed URL.

Incapable

The uploader is not capable of uploading this request due to lack of or mismatched capabilities.

e.g. The ping requires upload over OHTTP, but the uploader doesn’t support OHTTP.

HttpStatus

Fields

code: i32

The HTTP status code

A HTTP response code.

This can still indicate an error, depending on the status code.

Done

Signal that this uploader is done with work and won’t accept new work.

Implementations

impl UploadResult

pub fn get_label(&self) -> Option<&str>

Gets the label to be used in recording error counts for upload.

Returns None if the upload finished succesfully. Failures are recorded in the ping_upload_failure metric.

pub fn recoverable_failure() -> Self

A recoverable failure.

During upload something went wrong, e.g. the network connection failed. The upload should be retried at a later time.

pub fn unrecoverable_failure() -> Self

An unrecoverable upload failure.

A possible cause might be a malformed URL.

pub fn incapable() -> Self

The uploader is not capable of uploading this request due to lack of or mismatched capabilities.

e.g. The ping requires upload over OHTTP, but the uploader doesn’t support OHTTP.

pub fn http_status(code: i32) -> Self

A HTTP response code.

This can still indicate an error, depending on the status code.

pub fn done() -> Self

This uploader is done.

Trait Implementations

impl<UT> ConvertError<UT> for UploadResult

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError ) -> Result<Self>

impl Debug for UploadResult

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for UploadResult

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

impl<UT> Lift<UT> for UploadResult

type FfiType = <UploadResult as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for UploadResult

type LiftType = UploadResult

impl<UT> LiftReturn<UT> for UploadResult

type ReturnType = <UploadResult as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for UploadResult

type FfiType = <UploadResult as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for UploadResult

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for UploadResult

type ReturnType = <UploadResult as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for UploadResult

const TYPE_ID_META: MetadataBuffer = _