Struct PingRequest

pub struct PingRequest {
    pub document_id: String,
    pub path: String,
    pub body: Vec<u8>,
    pub headers: HeaderMap,
    pub body_has_info_sections: bool,
    pub ping_name: String,
    pub uploader_capabilities: Vec<String>,
}

Represents a request to upload a ping.

Fields

document_id: String

The Job ID to identify this request, this is the same as the ping UUID.

path: String

The path for the server to upload the ping to.

body: Vec<u8>

The body of the request, as a byte array. If gzip encoded, then the headers list will contain a Content-Encoding header with the value gzip.

headers: HeaderMap

A map with all the headers to be sent with the request.

body_has_info_sections: bool

Whether the body has {client|ping}_info sections.

ping_name: String

The ping’s name. Likely also somewhere in path.

uploader_capabilities: Vec<String>

The capabilities required during this ping’s upload.

Implementations

impl PingRequest

pub fn builder(language_binding_name: &str, body_max_size: usize) -> Builder

Creates a new builder-style structure to help build a PingRequest.

Arguments

• language_binding_name - The name of the language used by the binding that instantiated this Glean instance. This is used to build the X-Telemetry-Agent header value.
• body_max_size - The maximum size in bytes the compressed ping body may have to be eligible for upload.

pub fn is_deletion_request(&self) -> bool

Verifies if current request is for a deletion-request ping.

pub fn pretty_body(&self) -> Option<String>

Decompresses and pretty-format the ping payload

Should be used for logging when required. This decompresses the payload in memory.

Trait Implementations

impl Clone for PingRequest

fn clone(&self) -> PingRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for PingRequest

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

impl Debug for PingRequest

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for PingRequest

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

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.

impl<UT> Lift<UT> for PingRequest

type FfiType = <PingRequest 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 PingRequest

type LiftType = PingRequest

impl<UT> LiftReturn<UT> for PingRequest

type ReturnType = <PingRequest 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 PingRequest

type FfiType = <PingRequest 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 PingRequest

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PingRequest

type ReturnType = <PingRequest 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 PartialEq for PingRequest

fn eq(&self, other: &PingRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for PingRequest

const TYPE_ID_META: MetadataBuffer

impl Eq for PingRequest

impl StructuralPartialEq for PingRequest