Struct xml5ever::buffer_queue::BufferQueue

pub struct BufferQueue {
    buffers: RefCell<VecDeque<Tendril<UTF8>>>,
}

A queue of owned string buffers, which supports incrementally consuming characters.

Internally it uses VecDeque and has the same complexity properties.

Fields

buffers: RefCell<VecDeque<Tendril<UTF8>>>

Implementations

impl BufferQueue

pub fn is_empty(&self) -> bool

Returns whether the queue is empty.

pub fn pop_front(&self) -> Option<Tendril<UTF8>>

Get the buffer at the beginning of the queue.

pub fn push_front(&self, buf: Tendril<UTF8>)

Add a buffer to the beginning of the queue.

If the buffer is empty, it will be skipped.

pub fn push_back(&self, buf: Tendril<UTF8>)

Add a buffer to the end of the queue.

If the buffer is empty, it will be skipped.

pub fn peek(&self) -> Option<char>

Look at the next available character without removing it, if the queue is not empty.

pub fn pop_except_from(&self, set: SmallCharSet) -> Option<SetResult>

Pops and returns either a single character from the given set, or a buffer of characters none of which are in the set.

Examples

use markup5ever::buffer_queue::{BufferQueue, SetResult};

let mut queue = BufferQueue::default();
queue.push_back(format_tendril!(r#"<some_tag attr="text">SomeText</some_tag>"#));
let set = small_char_set!(b'<' b'>' b' ' b'=' b'"' b'/');
let tag = format_tendril!("some_tag");
let attr = format_tendril!("attr");
let attr_val = format_tendril!("text");
assert_eq!(queue.pop_except_from(set), Some(SetResult::FromSet('<')));
assert_eq!(queue.pop_except_from(set), Some(SetResult::NotFromSet(tag)));
assert_eq!(queue.pop_except_from(set), Some(SetResult::FromSet(' ')));
assert_eq!(queue.pop_except_from(set), Some(SetResult::NotFromSet(attr)));
assert_eq!(queue.pop_except_from(set), Some(SetResult::FromSet('=')));
assert_eq!(queue.pop_except_from(set), Some(SetResult::FromSet('"')));
assert_eq!(queue.pop_except_from(set), Some(SetResult::NotFromSet(attr_val)));
// ...

pub fn eat<F>(&self, pat: &str, eq: F) -> Option<bool>

where F: Fn(&u8, &u8) -> bool,

Consume bytes matching the pattern, using a custom comparison function eq.

Returns Some(true) if there is a match, Some(false) if there is no match, or None if it wasn’t possible to know (more data is needed).

The custom comparison function is used elsewhere to compare ascii-case-insensitively.

Examples

use markup5ever::buffer_queue::BufferQueue;

let mut queue = BufferQueue::default();
queue.push_back(format_tendril!("testtext"));
let test_str = "test";
assert_eq!(queue.eat("test", |&a, &b| a == b), Some(true));
assert_eq!(queue.eat("text", |&a, &b| a == b), Some(true));
assert!(queue.is_empty());

pub fn next(&self) -> Option<char>

Get the next character if one is available, removing it from the queue.

This function manages the buffers, removing them as they become empty.

pub fn replace_with(&self, other: BufferQueue)

pub fn swap_with(&self, other: &BufferQueue)

Trait Implementations

impl Debug for BufferQueue

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

Formats the value using the given formatter.

impl Default for BufferQueue

fn default() -> BufferQueue

Create an empty BufferQueue.