Struct Output 

pub struct Output<'a> { /* private fields */ }

Where an engine writes: the reply body, reused between requests, with a size budget.

use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 64);
out.write_str("<p>hi</p>")?;
assert_eq!(out.remaining(), 55);
assert_eq!(buf, b"<p>hi</p>");

Implementations

impl<'a> Output<'a>

pub fn new(buf: &'a mut Vec<u8>, limit: usize) -> Self

An output over buf, refusing to grow past limit bytes.

use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 4);
assert!(out.write(b"1234").is_ok());
assert_eq!(out.write(b"5").unwrap_err().code(), "render.too_large");

pub fn write(&mut self, bytes: &[u8]) -> Result<(), RenderError>

Appends bytes.

use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 64);
out.write(b"<p>")?;
assert_eq!(out.len(), 3);

Errors

render.too_large when the page would pass the budget.

pub fn write_str(&mut self, s: &str) -> Result<(), RenderError>

Appends a string.

use web_net::{Output, escape_html};

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 64);
out.write_str(&escape_html("a<b"))?;
assert_eq!(buf, b"a&lt;b");

Errors

As write.

pub fn buffer(&mut self) -> &mut Vec<u8>

The buffer itself, for an engine that writes into a Vec<u8>. The budget is checked when the engine returns: a page past it is refused with render.too_large.

use std::io::Write;
use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 64);
write!(out.buffer(), "{} items", 3).unwrap();
assert_eq!(out.len(), 7);

pub fn len(&self) -> usize

Bytes written so far.

use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 64);
out.write_str("hello")?;
assert_eq!(out.len(), 5);

pub fn is_empty(&self) -> bool

Whether nothing was written yet.

use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 64);
assert!(out.is_empty());
out.write_str("x")?;
assert!(!out.is_empty());

pub fn remaining(&self) -> usize

The bytes still allowed.

use web_net::Output;

let mut buf = Vec::new();
let mut out = Output::new(&mut buf, 10);
out.write_str("abc")?;
assert_eq!(out.remaining(), 7);

Trait Implementations

impl Debug for Output<'_>

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

Formats the value using the given formatter.