libsip 0.2.6

SIP protocol Implementation, with a focus towords softphone clients.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use serde::{Deserialize, Serialize};

use std::{fmt, io::Result as IoResult, str::FromStr};

use nom::{character::complete::char, combinator::opt, error::ParseError, sequence::pair, IResult};

pub mod schema;
pub use self::schema::{parse_schema, UriSchema};

pub mod domain;
pub use self::domain::{parse_domain, parse_port, Domain};

pub mod params;
pub use self::params::{parse_param, parse_params, UriParam};

pub mod auth;
pub use self::auth::{parse_uriauth, UriAuth};

/// Universal Rescource Identifier for libsip.
#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
pub struct Uri {
    pub schema: Option<UriSchema>,
    pub host: Domain,
    pub auth: Option<UriAuth>,
    pub parameters: Vec<UriParam>,
}

impl Uri {
    pub fn new(schema: UriSchema, host: Domain) -> Uri {
        Uri {
            schema: Some(schema),
            host,
            auth: None,
            parameters: vec![],
        }
    }

    /// Create a new Uri without schema.
    pub fn new_schemaless(host: Domain) -> Uri {
        Uri {
            schema: None,
            host,
            auth: None,
            parameters: vec![],
        }
    }

    /// Create a new Uri With schema set to `Schema::Sip`.
    pub fn sip(host: Domain) -> Uri {
        Uri::new(UriSchema::Sip, host)
    }

    /// Create a new Uri With schema set to `Schema::Sips`.
    pub fn sips(host: Domain) -> Uri {
        Uri::new(UriSchema::Sips, host)
    }

    /// Add a `UriAuth` section to this Uri.
    pub fn auth(mut self, auth: UriAuth) -> Uri {
        self.auth = Some(auth);
        self
    }

    /// Remove authentication if there is any.
    pub fn authless(mut self) -> Uri {
        self.auth = None;
        self
    }

    /// Add a new parameter to the parameter list.
    pub fn parameter(mut self, p: UriParam) -> Uri {
        self.parameters.push(p);
        self
    }

    /// Add a list of new parameters. This will remove
    /// all old parameters.
    pub fn parameters(mut self, p: Vec<UriParam>) -> Uri {
        self.parameters = p;
        self
    }

    /// Remove the Schema if there is any.
    pub fn schemaless(mut self) -> Uri {
        self.schema = None;
        self
    }

    /// Set a new Schema.
    pub fn schema(mut self, schema: UriSchema) -> Uri {
        self.schema = Some(schema);
        self
    }

    /// Set the host value.
    pub fn host(&self) -> String {
        format!("{}", self.host)
    }

    /// Retrieve a formatted string containing host and parameters.
    /// This can be used in the Via header.
    pub fn host_and_params(&self) -> IoResult<String> {
        let mut host = self.host();
        for param in &self.parameters {
            host += &format!("{}", param);
        }
        Ok(host)
    }
}

impl fmt::Display for Uri {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if let Some(schema) = self.schema {
            write!(f, "{}:", schema)?;
        }
        if let Some(auth) = &self.auth {
            write!(f, "{}@{}", auth, self.host)?;
        } else {
            write!(f, "{}", self.host)?;
        }
        for param in &self.parameters {
            write!(f, "{}", param)?;
        }
        Ok(())
    }
}

pub fn parse_uri<'a, E: ParseError<&'a [u8]>>(input: &'a [u8]) -> IResult<&'a [u8], Uri, E> {
    let (input, schema) = opt(pair(parse_schema::<E>, char(':')))(input)?;
    let (input, auth) = opt(parse_uriauth::<E>)(input)?;
    let (input, host) = parse_domain::<E>(input)?;
    let (input, parameters) = parse_params::<E>(input)?;
    Ok((
        input,
        Uri {
            schema: schema.map(|item| item.0),
            host,
            parameters,
            auth,
        },
    ))
}

impl FromStr for Uri {
    type Err = nom::Err<nom::error::ErrorKind>;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(parse_uri(s.as_bytes()).map_err(map_error)?.1)
    }
}

fn map_error(n: nom::Err<(&[u8], nom::error::ErrorKind)>) -> nom::Err<nom::error::ErrorKind> {
    match n {
        nom::Err::Error((_, a)) => nom::Err::Error(a),
        nom::Err::Failure((_, b)) => nom::Err::Failure(b),
        nom::Err::Incomplete(a) => nom::Err::Incomplete(a),
    }
}