Struct glean_core::upload::PingRequest[−][src]

pub struct PingRequest {
    pub document_id: String,
    pub path: String,
    pub body: Vec<u8>,
    pub headers: HeaderMap,
}
Expand description

Represents a request to upload a ping.

Fields

document_id: String
Expand description

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

path: String
Expand description

The path for the server to upload the ping to.

body: Vec<u8>
Expand description

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
Expand description

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

Implementations

impl PingRequest[src]

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

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 User-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[src]

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

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

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[src]

fn clone(&self) -> PingRequest[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for PingRequest[src]

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

Formats the value using the given formatter. Read more

impl PartialEq<PingRequest> for PingRequest[src]

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

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &PingRequest) -> bool[src]

This method tests for !=.

impl StructuralPartialEq for PingRequest[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.