Struct LiteralData

pub struct LiteralData { /* private fields */ }

Literal Data Packet https://www.rfc-editor.org/rfc/rfc9580.html#name-literal-data-packet-type-id

Implementations

impl LiteralData

pub fn from_str(file_name: impl Into<BString>, raw_data: &str) -> Self

Creates a literal data packet from the given string. Normalizes line endings.

pub fn from_bytes(file_name: &BStr, data: &[u8]) -> Self

Creates a literal data packet from the given bytes.

pub fn from_slice(packet_version: Version, input: &[u8]) -> Result<Self>

Parses a LiteralData packet from the given slice.

pub fn is_binary(&self) -> bool

pub fn data(&self) -> &[u8]

pub fn into_bytes(self) -> Vec<u8>

Extracts data in to raw data

pub fn try_into_string(self) -> Result<String, Vec<u8>>

Extracts data as string, returning raw bytes as Err if not valid utf-8 string

pub fn to_string(&self) -> Option<String>

Convert the data to a UTF-8 string, if appropriate for the type. Returns None if mode is Binary, or the data is not valid UTF-8.

Trait Implementations

impl AsRef<[u8]> for LiteralData

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for LiteralData

fn clone(&self) -> LiteralData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LiteralData

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

Formats the value using the given formatter.

impl From<LiteralData> for Packet

fn from(other: LiteralData) -> Packet

Converts to this type from the input type.

impl PacketTrait for LiteralData

fn packet_version(&self) -> Version

fn tag(&self) -> Tag

impl PartialEq for LiteralData

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LiteralData

fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

fn to_bytes(&self) -> Result<Vec<u8>>

impl TryFrom<Packet> for LiteralData

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Packet) -> Result<LiteralData, Self::Error>

Performs the conversion.

impl Eq for LiteralData

impl StructuralPartialEq for LiteralData