Skip to main content

Bencode

Enum Bencode 

Source
pub enum Bencode {
    Int(i64),
    Bytes(Vec<u8>),
    List(Vec<Bencode>),
    Dict(BTreeMap<Vec<u8>, Bencode>),
}
Expand description

A bencoded value — the four shapes the grammar admits.

Bytes is the only string type: bencode has no text/binary distinction on the wire, so the AST keeps raw bytes and offers Bencode::as_str for the UTF-8 view when a field is known textual. Dict is a BTreeMap so iteration — and therefore Bencode::to_bytes — is always in the sorted-key canonical order the protocol requires.

Variants§

§

Int(i64)

i<decimal>e — a 64-bit signed integer.

§

Bytes(Vec<u8>)

<len>:<bytes> — a length-prefixed byte string.

§

List(Vec<Bencode>)

l<elements>e — an ordered list.

§

Dict(BTreeMap<Vec<u8>, Bencode>)

d<key><value>…e — keys are byte strings, sorted + unique.

Implementations§

Source§

impl Bencode

Source

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

Encode to canonical bencode bytes through a typed builder — never a format!() of the wire syntax (the ★★ TYPED EMISSION rule). Dict keys emit in sorted order (BTreeMap iteration), the canonicalization BitTorrent info-hashing relies on.

Source

pub fn as_int(&self) -> Option<i64>

The integer, if this is an Bencode::Int.

Source

pub fn as_bytes(&self) -> Option<&[u8]>

The raw bytes, if this is a Bencode::Bytes.

Source

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

The UTF-8 string view of a byte string, if valid UTF-8.

Source

pub fn as_list(&self) -> Option<&[Bencode]>

The elements, if this is a Bencode::List.

Source

pub fn as_dict(&self) -> Option<&BTreeMap<Vec<u8>, Bencode>>

The map, if this is a Bencode::Dict.

Source

pub fn get(&self, key: &[u8]) -> Option<&Bencode>

Look up a key in a dict (by byte key). None if not a dict or the key is absent.

Trait Implementations§

Source§

impl Clone for Bencode

Source§

fn clone(&self) -> Bencode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Bencode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Bencode

Source§

impl PartialEq for Bencode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Bencode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.