Struct RequestBuilder 

pub struct RequestBuilder { /* private fields */ }

Builds a request.

let uri = Uri::sip(Host::Name(HostName::new("example.com")?));
let request = RequestBuilder::new(Method::Options, uri)
    .header(HeaderName::CallId, "abc123@example.com")?
    .max_forwards(70)
    .build();

Implementations

impl RequestBuilder

pub fn new(method: Method, uri: Uri) -> Self

Start a request.

pub fn header( self, name: HeaderName, value: impl Into<Bytes>, ) -> Result<Self, BuildError>

Append a header, rejecting a value that could inject a line break.

pub fn set_header( self, name: &HeaderName, value: impl Into<Bytes>, ) -> Result<Self, BuildError>

Replace every header of this name with one carrying this value.

Distinct from Self::header because appending is right for Via and Route, where repetition is meaningful, and wrong for To or CSeq, where a second copy makes the message invalid.

pub fn max_forwards(self, hops: u8) -> Self

Append a Max-Forwards header. Cannot fail: a u8 has no CRLF in it.

pub fn cseq(self, sequence: u32, method: &Method) -> Result<Self, BuildError>

Append a CSeq header.

pub fn body(self, body: impl Into<Bytes>) -> Self

Set the body, and the Content-Length that goes with it.

The two are set together because a body without a matching length is a framing bug waiting to happen, and there is no reason to let a caller create one.

pub fn build(self) -> Request

Finish.

If no body was set, a Content-Length: 0 is added, because a stream transport cannot frame a message without one.

Trait Implementations

impl Debug for RequestBuilder

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

Formats the value using the given formatter.