Struct lazy_bencoding::BEncoded [] [src]

pub struct BEncoded<'a> {
    pub data: &'a [u8],
    pub depth: i16,
}

Token iterator instance

Example

extern crate lazy_bencoding;
use lazy_bencoding::*;

let bencoded = BEncoded::new(&data[..]);
let name = bencoded.get(b"info").get(b"name").get_utf8_string();

You may now:

Fields

data

Next data to parse, only a cheap reference and updated with each next()

depth

Keeping track of the depth, for:

  • traversing, and
  • stopping after one item, before trailing data.

Methods

impl<'a> BEncoded<'a>

fn new(data: &'a [u8]) -> Self

Construct from a pointer to data

fn empty() -> BEncoded<'static>

Construct with empty data, used for when traversing fails

impl<'a> BEncoded<'a>

fn is_dict(&self) -> bool

Is the remaining data a dict?

fn is_list(&self) -> bool

Is the remaining data a list?

fn get_byte_string(&self) -> Option<&'a [u8]>

Is the remaining data a string? Then get it as a cheap slice.

fn get_utf8_string(&self) -> Option<&'a str>

Is the remaining data a string? Then get it as checked UTF-8.

fn get_integer(&self) -> Option<i64>

Is the remaining data an integer? If so, parse and return it.

fn this_and_rest(self) -> Option<(BEncoded<'a>, &'a [u8])>

Used by dict() and list()

Restricts the BEncoded<'a> to a single item (string, integer, list, or dict). Also returns the trailing data.

fn list(&self) -> ListIterator

If the remaining data is a list, return value fulfills Iterator<Item=BEncoded<'a>>

fn dict(&self) -> DictIterator

If the remaining data is a dict, return value fulfills Iterator<Item=(BEncoded<'a>, BEncoded<'a>)>

fn get(&'a self, wanted_key: &'a [u8]) -> Self

From a dict(), get the value of key wanted_key.

In case the key is not present, we return an empty instance. This allows chaining these calls conveniently:

let bencoded = BEncoded::new(b"d1:ad1:ad1:a4:spame1:bd1:a4:eggseee");
assert_eq!(bencoded.get(b"a").get(b"b").get(b"a").get_utf8_string(),
           Some("eggs"));

Trait Implementations

impl<'a> Iterator for BEncoded<'a>

The token stream. Advances self.data and updates self.depth.

type Item = Token<'a>

fn next(&mut self) -> Option<Self::Item>

1.0.0fn size_hint(&self) -> (usize, Option<usize>)

1.0.0fn count(self) -> usize

1.0.0fn last(self) -> Option<Self::Item>

1.0.0fn nth(&mut self, n: usize) -> Option<Self::Item>

1.0.0fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> where U: IntoIterator<Item=Self::Item>

1.0.0fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator

1.0.0fn map<B, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> B

1.0.0fn filter<P>(self, predicate: P) -> Filter<Self, P> where P: FnMut(&Self::Item) -> bool

1.0.0fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>

1.0.0fn enumerate(self) -> Enumerate<Self>

1.0.0fn peekable(self) -> Peekable<Self>

1.0.0fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where P: FnMut(&Self::Item) -> bool

1.0.0fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where P: FnMut(&Self::Item) -> bool

1.0.0fn skip(self, n: usize) -> Skip<Self>

1.0.0fn take(self, n: usize) -> Take<Self>

1.0.0fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where F: FnMut(&mut St, Self::Item) -> Option<B>

1.0.0fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where U: IntoIterator, F: FnMut(Self::Item) -> U

1.0.0fn fuse(self) -> Fuse<Self>

1.0.0fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item) -> ()

1.0.0fn by_ref(&mut self) -> &mut Self

1.0.0fn collect<B>(self) -> B where B: FromIterator<Self::Item>

1.0.0fn partition<B, F>(self, f: F) -> (B, B) where B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool

1.0.0fn fold<B, F>(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B

1.0.0fn all<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

1.0.0fn any<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

1.0.0fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where P: FnMut(&Self::Item) -> bool

1.0.0fn position<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool

1.0.0fn rposition<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool, Self: ExactSizeIterator + DoubleEndedIterator

1.0.0fn max(self) -> Option<Self::Item> where Self::Item: Ord

1.0.0fn min(self) -> Option<Self::Item> where Self::Item: Ord

fn max_by<B, F>(self, f: F) -> Option<Self::Item> where F: FnMut(&Self::Item) -> B, B: Ord

1.6.0fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where F: FnMut(&Self::Item) -> B, B: Ord

fn min_by<B, F>(self, f: F) -> Option<Self::Item> where F: FnMut(&Self::Item) -> B, B: Ord

1.6.0fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where F: FnMut(&Self::Item) -> B, B: Ord

1.0.0fn rev(self) -> Rev<Self> where Self: DoubleEndedIterator

1.0.0fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Iterator<Item=(A, B)>

1.0.0fn cloned<'a, T>(self) -> Cloned<Self> where T: 'a + Clone, Self: Iterator<Item=&'a T>

1.0.0fn cycle(self) -> Cycle<Self> where Self: Clone

fn sum<S>(self) -> S where S: Add<Self::Item, Output=S> + Zero

fn product<P>(self) -> P where P: Mul<Self::Item, Output=P> + One

1.5.0fn cmp<I>(self, other: I) -> Ordering where I: IntoIterator<Item=Self::Item>, Self::Item: Ord

1.5.0fn partial_cmp<I>(self, other: I) -> Option<Ordering> where I: IntoIterator, Self::Item: PartialOrd<I::Item>

1.5.0fn eq<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>

1.5.0fn ne<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>

1.5.0fn lt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

1.5.0fn le<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

1.5.0fn gt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

1.5.0fn ge<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

Derived Implementations

impl<'a> Clone for BEncoded<'a>

fn clone(&self) -> BEncoded<'a>

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