Struct Uri

Source

pub struct Uri {
    pub scheme: Scheme,
    pub user: Option<String>,
    pub password: Option<String>,
    pub host: Host,
    pub port: Option<u16>,
    pub parameters: Vec<Param>,
    pub headers: HashMap<String, String>,
    pub raw_uri: Option<String>,
}

Expand description

SIP URI components as defined in RFC 3261

Represents a complete SIP URI with all its components. URIs are used throughout the SIP protocol to identify endpoints, proxy servers, redirect servers, and other network elements.

§Structure

A complete SIP URI has the following format: sip:user:password@host:port;uri-parameters?headers

§Examples

use rvoip_sip_core::prelude::*;
use std::str::FromStr;

// Parse a URI from a string
let uri = Uri::from_str("sip:alice@example.com").unwrap();

// Create a URI programmatically
let uri = Uri::sip("example.com")
    .with_user("bob")
    .with_port(5060)
    .with_parameter(Param::transport("tcp"));

// Get components
assert_eq!(uri.scheme.as_str(), "sip");
assert_eq!(uri.username(), Some("bob"));
assert_eq!(uri.port, Some(5060));
assert_eq!(uri.transport(), Some("tcp"));

Fields§

§scheme: Scheme

URI scheme (sip, sips, tel)

§user: Option<String>

User part (optional)

§password: Option<String>

Password (optional, deprecated)

§host: Host

Host (required)

§port: Option<u16>

Port (optional)

§parameters: Vec<Param>

URI parameters (;key=value or ;key)

§headers: HashMap<String, String>

URI headers (?key=value)

§raw_uri: Option<String>

Raw URI string for custom schemes

Implementations§

Source §

impl Uri

Source

pub fn new(scheme: Scheme, host: Host) -> Uri

Create a new URI with the minimum required fields

§Parameters

scheme: The URI scheme
host: The host part

§Returns

A new URI instance with the given scheme and host

Source

pub fn scheme(&self) -> &Scheme

Returns the scheme of this URI

§Returns

The scheme (e.g., Sip, Sips, Tel)

Source

pub fn host_port(&self) -> String

Returns the host and port (if present) formatted as a string

§Returns

The host and port as a string (e.g., “example.com:5060”)

Source

pub fn sip(host: impl Into<String>) -> Uri

Create a new SIP URI with a domain host

§Parameters

host: The domain name

§Returns

A new URI with SIP scheme and the given domain host

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::sip("example.com");
assert_eq!(uri.to_string(), "sip:example.com");

Source

pub fn sip_ipv4(host: impl Into<String>) -> Uri

Create a new SIP URI with an IPv4 host

§Parameters

host: The IPv4 address as a string

§Returns

A new URI with SIP scheme and the given IPv4 host

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::sip_ipv4("192.168.1.1");
assert_eq!(uri.to_string(), "sip:192.168.1.1");

Source

pub fn sip_ipv6(host: impl Into<String>) -> Uri

Create a new SIP URI with an IPv6 host

§Parameters

host: The IPv6 address as a string

§Returns

A new URI with SIP scheme and the given IPv6 host

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::sip_ipv6("2001:db8::1");
assert_eq!(uri.to_string(), "sip:[2001:db8::1]");

Source

pub fn sips(host: impl Into<String>) -> Uri

Create a new SIPS URI

§Parameters

host: The domain name

§Returns

A new URI with SIPS scheme and the given domain host

Source

pub fn tel(number: impl Into<String>) -> Uri

Create a new TEL URI

§Parameters

number: The telephone number

§Returns

A new URI with TEL scheme and the given number as host

Source

pub fn http(host: impl Into<String>) -> Uri

Create a new HTTP URI

§Parameters

host: The domain name

§Returns

A new URI with HTTP scheme and the given domain host

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::http("example.com");
assert_eq!(uri.to_string(), "http:example.com");

Source

pub fn https(host: impl Into<String>) -> Uri

Create a new HTTPS URI

§Parameters

host: The domain name

§Returns

A new URI with HTTPS scheme and the given domain host

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::https("example.com");
assert_eq!(uri.to_string(), "https:example.com");

Source

pub fn custom(uri_string: impl Into<String>) -> Uri

Create a new URI with a custom scheme by storing the entire URI string This is used for schemes that are not explicitly supported (like http, https) but need to be preserved in the Call-Info header

§Parameters

uri_string: The full URI string

§Returns

A new URI with the appropriate scheme and preserved raw string

Source

pub fn is_custom(&self) -> bool

Check if this URI has a custom scheme (non-SIP)

§Returns

true if this is a custom URI, false otherwise

Source

pub fn as_raw_uri(&self) -> Option<&str>

Get the raw URI string if this is a custom URI

§Returns

The raw URI string if this is a custom URI, None otherwise

Source

pub fn username(&self) -> Option<&str>

Get the username part of the URI, if present

§Returns

The username as a string slice, or None if not set

Source

pub fn with_user(self, user: impl Into<String>) -> Uri

Set the user part of the URI

§Parameters

user: The user part to set

§Returns

Self for method chaining

Source

pub fn with_password(self, password: impl Into<String>) -> Uri

Set the password part of the URI (deprecated in SIP)

§Parameters

password: The password to set

§Returns

Self for method chaining

§Note

Passwords in SIP URIs are deprecated for security reasons, but supported for compatibility.

Source

pub fn with_port(self, port: u16) -> Uri

Set the port part of the URI

§Parameters

port: The port number

§Returns

Self for method chaining

Source

pub fn with_parameter(self, param: Param) -> Uri

Add a parameter to the URI

§Parameters

param: The parameter to add

§Returns

Self for method chaining

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::sip("example.com")
    .with_parameter(Param::transport("tcp"))
    .with_parameter(Param::ttl(60));

assert_eq!(uri.to_string(), "sip:example.com;transport=tcp;ttl=60");

Source

pub fn with_header( self, key: impl Into<String>, value: impl Into<String>, ) -> Uri

Add a header to the URI

§Parameters

key: The header name
value: The header value

§Returns

Self for method chaining

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::sip("example.com")
    .with_header("subject", "Meeting")
    .with_header("priority", "urgent");

// Headers are added to the URI string
let uri_str = uri.to_string();
assert!(uri_str.contains("subject=Meeting"));
assert!(uri_str.contains("priority=urgent"));

Source

pub fn transport(&self) -> Option<&str>

Returns the transport parameter if present

§Returns

The transport value as a string slice, or None if not set

§Examples

use rvoip_sip_core::prelude::*;

let uri = Uri::sip("example.com")
    .with_parameter(Param::transport("tcp"));

assert_eq!(uri.transport(), Some("tcp"));

Source

pub fn is_phone_number(&self) -> bool

Returns the user=phone parameter if present

§Returns

true if the URI has the user=phone parameter, false otherwise

§Examples

use rvoip_sip_core::prelude::*;
use std::str::FromStr;

let uri = Uri::from_str("sip:+12125551212@example.com;user=phone").unwrap();
assert!(uri.is_phone_number());

let uri = Uri::sip("example.com").with_user("alice");
assert!(!uri.is_phone_number());