Struct rtcp_types::ByeBuilder
source · pub struct ByeBuilder<'a> { /* private fields */ }
Expand description
Bye packet Builder
Implementations§
source§impl<'a> ByeBuilder<'a>
impl<'a> ByeBuilder<'a>
sourcepub fn padding(self, padding: u8) -> Self
pub fn padding(self, padding: u8) -> Self
Sets the number of padding bytes to use for this Bye packet.
sourcepub fn add_source(self, source: u32) -> Self
pub fn add_source(self, source: u32) -> Self
Attempts to add the provided Source.
sourcepub fn reason(self, reason: impl Into<Cow<'a, str>>) -> Self
pub fn reason(self, reason: impl Into<Cow<'a, str>>) -> Self
Sets the reason for this Bye packet.
sourcepub fn reason_owned(
self,
reason: impl Into<Cow<'a, str>>
) -> ByeBuilder<'static>
pub fn reason_owned( self, reason: impl Into<Cow<'a, str>> ) -> ByeBuilder<'static>
Sets the (owned) reason for this Bye packet.
Trait Implementations§
source§impl<'a> Debug for ByeBuilder<'a>
impl<'a> Debug for ByeBuilder<'a>
source§impl<'a> From<ByeBuilder<'a>> for PacketBuilder<'a>
impl<'a> From<ByeBuilder<'a>> for PacketBuilder<'a>
source§fn from(pb: ByeBuilder<'a>) -> Self
fn from(pb: ByeBuilder<'a>) -> Self
Converts to this type from the input type.
source§impl<'a> RtcpPacketWriter for ByeBuilder<'a>
impl<'a> RtcpPacketWriter for ByeBuilder<'a>
source§fn calculate_size(&self) -> Result<usize, RtcpWriteError>
fn calculate_size(&self) -> Result<usize, RtcpWriteError>
Calculates the size required to write this Bye packet.
Returns an error if:
- Too many sources where added.
- The length of the reason is out of range.
- The padding is not a multiple of 4.
source§fn write_into_unchecked(&self, buf: &mut [u8]) -> usize
fn write_into_unchecked(&self, buf: &mut [u8]) -> usize
Write this Bye packet data into buf
without any validity checks.
Returns the number of bytes written.
Panic
Panics if the buf is not large enough.
source§fn get_padding(&self) -> Option<u8>
fn get_padding(&self) -> Option<u8>
Gets the padding that was configured for this RTCP packet.
Auto Trait Implementations§
impl<'a> RefUnwindSafe for ByeBuilder<'a>
impl<'a> Send for ByeBuilder<'a>
impl<'a> Sync for ByeBuilder<'a>
impl<'a> Unpin for ByeBuilder<'a>
impl<'a> UnwindSafe for ByeBuilder<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> RtcpPacketWriterExt for Twhere
T: RtcpPacketWriter,
impl<T> RtcpPacketWriterExt for Twhere
T: RtcpPacketWriter,
source§fn write_into(&self, buf: &mut [u8]) -> Result<usize, RtcpWriteError>
fn write_into(&self, buf: &mut [u8]) -> Result<usize, RtcpWriteError>
Writes the Custom packet into
buf
. Read more