Struct glean::net::PingRequest
source · [−]pub struct PingRequest {
pub document_id: String,
pub path: String,
pub body: Vec<u8, Global>,
pub headers: HashMap<String, String, RandomState>,
}
Expand description
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, Global>
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<String, String, RandomState>
A map with all the headers to be sent with the request.
Implementations
sourceimpl PingRequest
impl PingRequest
sourcepub fn builder(language_binding_name: &str, body_max_size: usize) -> Builder
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.
sourcepub fn is_deletion_request(&self) -> bool
pub fn is_deletion_request(&self) -> bool
Verifies if current request is for a deletion-request ping.
sourcepub fn pretty_body(&self) -> Option<String>
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
sourceimpl Clone for PingRequest
impl Clone for PingRequest
sourcefn clone(&self) -> PingRequest
fn clone(&self) -> PingRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PingRequest
impl Debug for PingRequest
sourceimpl PartialEq<PingRequest> for PingRequest
impl PartialEq<PingRequest> for PingRequest
sourcefn eq(&self, other: &PingRequest) -> bool
fn eq(&self, other: &PingRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PingRequest) -> bool
fn ne(&self, other: &PingRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for PingRequest
Auto Trait Implementations
impl RefUnwindSafe for PingRequest
impl Send for PingRequest
impl Sync for PingRequest
impl Unpin for PingRequest
impl UnwindSafe for PingRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more