Struct glean_core::upload::PingRequest

pub struct PingRequest {
    pub document_id: String,
    pub path: String,
    pub body: Vec<u8>,
    pub headers: HashMap<&'static str, 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: HashMap<&'static str, String>

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

Implementations

impl PingRequest

pub fn new(document_id: &str, path: &str, body: JsonValue) -> Self

Creates a new PingRequest.

Automatically creates the default request headers.

pub fn is_deletion_request(&self) -> bool

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

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

Decompress 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 copy of the value.

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

Performs copy-assignment from source.

impl Debug for PingRequest

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

Formats the value using the given formatter.

impl PartialEq<PingRequest> for PingRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for PingRequest