Struct sentry_contrib_native::Dsn

pub struct Dsn { /* fields omitted */ }

This is supported on crate feature transport-custom only.

Contains the pieces that are needed to build correct headers for a request based on the given DSN.

Examples

#![cfg(feature = "transport-custom")]


struct CustomTransport {
    dsn: Dsn,
};

impl CustomTransport {
    fn new(options: &Options) -> Result<Self, ()> {
        Ok(CustomTransport {
            // we can also get the DSN here
            dsn: options.dsn().and_then(|dsn| Dsn::new(dsn).ok()).ok_or(())?,
        })
    }
}

impl Transport for CustomTransport {
    fn send(&self, envelope: RawEnvelope) {
        // we need `Dsn` to build the `Request`!
        envelope.to_request(self.dsn.clone());
        // or build your own request with the help of a URL, `HeaderMap` and body.
        let (url, headers, body): (&str, HeaderMap, &[u8]) = (self.dsn.url(), self.dsn.to_headers(), envelope.serialize().as_bytes());
    }
}

let dsn = "https://public_key_1234@organization_1234.ingest.sentry.io/project_id_1234";

let mut options = Options::new();
options.set_dsn(dsn);
// we can take the `dsn` right here
let custom_transport = CustomTransport {
    dsn: Dsn::new(dsn)?,
};
options.set_transport(move |_| Ok(custom_transport));
// this is also possible
options.set_transport(|options| Ok(CustomTransport {
    dsn: options.dsn().and_then(|dsn| Dsn::new(dsn).ok()).ok_or(())?,
}));
// or use a method more directly
options.set_transport(CustomTransport::new);

Implementations

impl Dsn

pub fn new(dsn: &str) -> Result<Self, Error>

Creates a new Dsn from a str.

Errors

Fails with Error::Transport if the DSN is invalid.

#[must_use]

pub fn auth(&self) -> &str

The auth header value.

#[must_use]

pub fn url(&self) -> &str

The full URL to send envelopes to.

#[must_use]

pub fn into_parts(self) -> Parts

Consume Dsn and return it’s parts.

#[must_use]

pub fn to_headers(&self) -> HeaderMap

Yields a HeaderMap to build a correct HTTP request with this Dsn.

Trait Implementations

impl Clone for Dsn

fn clone(&self) -> Dsn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dsn

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

Formats the value using the given formatter.

impl Eq for Dsn

impl FromStr for Dsn

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Dsn

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Dsn

fn cmp(&self, other: &Dsn) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Dsn> for Dsn

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

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

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

This method tests for !=.

impl PartialOrd<Dsn> for Dsn

fn partial_cmp(&self, other: &Dsn) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Dsn

impl StructuralPartialEq for Dsn

impl TryFrom<&'_ str> for Dsn

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.