From c402b25bf0cb0ce4e92ed9371f57fb42f65c8d72 Mon Sep 17 00:00:00 2001 From: Noah Hellman Date: Fri, 2 Aug 2024 18:18:40 +0200 Subject: [PATCH] lib: rename RenderRef::*_borrowed -> RenderRef::*_ref match name of trait and similarly named methods like get_ref, as_ref etc. --- bench/criterion/main.rs | 10 +++++----- src/html.rs | 2 +- src/lib.rs | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/bench/criterion/main.rs b/bench/criterion/main.rs index 969767b..b253104 100644 --- a/bench/criterion/main.rs +++ b/bench/criterion/main.rs @@ -56,8 +56,8 @@ fn gen_html(c: &mut criterion::Criterion) { } criterion_group!(html, gen_html); -fn gen_html_borrow(c: &mut criterion::Criterion) { - let mut group = c.benchmark_group("html_borrow"); +fn gen_html_ref(c: &mut criterion::Criterion) { + let mut group = c.benchmark_group("html_ref"); for (name, input) in bench_input::INPUTS { group.throughput(criterion::Throughput::Elements( jotdown::Parser::new(input).count() as u64, @@ -72,7 +72,7 @@ fn gen_html_borrow(c: &mut criterion::Criterion) { use jotdown::RenderRef; let mut s = String::new(); jotdown::html::Renderer::default() - .push_borrowed(p.as_slice().iter(), &mut s) + .push_ref(p.as_slice().iter(), &mut s) .unwrap(); s }, @@ -82,7 +82,7 @@ fn gen_html_borrow(c: &mut criterion::Criterion) { ); } } -criterion_group!(html_borrow, gen_html_borrow); +criterion_group!(html_ref, gen_html_ref); fn gen_html_clone(c: &mut criterion::Criterion) { let mut group = c.benchmark_group("html_clone"); @@ -122,4 +122,4 @@ fn gen_full(c: &mut criterion::Criterion) { } criterion_group!(full, gen_full); -criterion_main!(block, inline, html, html_borrow, html_clone, full); +criterion_main!(block, inline, html, html_ref, html_clone, full); diff --git a/src/html.rs b/src/html.rs index 18ed3cd..83b96e4 100644 --- a/src/html.rs +++ b/src/html.rs @@ -48,7 +48,7 @@ impl Render for Renderer { } impl RenderRef for Renderer { - fn push_borrowed<'s, E, I, W>(&self, mut events: I, mut out: W) -> std::fmt::Result + fn push_ref<'s, E, I, W>(&self, mut events: I, mut out: W) -> std::fmt::Result where E: AsRef>, I: Iterator, diff --git a/src/lib.rs b/src/lib.rs index 36cbdf7..99b3a9d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -145,10 +145,10 @@ pub trait RenderRef { /// # let events: &[jotdown::Event] = &[]; /// let mut output = String::new(); /// let renderer = jotdown::html::Renderer::default(); - /// renderer.push_borrowed(events.iter(), &mut output); + /// renderer.push_ref(events.iter(), &mut output); /// # } /// ``` - fn push_borrowed<'s, E, I, W>(&self, events: I, out: W) -> fmt::Result + fn push_ref<'s, E, I, W>(&self, events: I, out: W) -> fmt::Result where E: AsRef>, I: Iterator, @@ -158,7 +158,7 @@ pub trait RenderRef { /// /// NOTE: This performs many small writes, so IO writes should be buffered with e.g. /// [`std::io::BufWriter`]. - fn write_borrowed<'s, E, I, W>(&self, events: I, out: W) -> io::Result<()> + fn write_ref<'s, E, I, W>(&self, events: I, out: W) -> io::Result<()> where E: AsRef>, I: Iterator, @@ -169,7 +169,7 @@ pub trait RenderRef { error: Ok(()), }; - self.push_borrowed(events, &mut out) + self.push_ref(events, &mut out) .map_err(|_| match out.error { Err(e) => e, _ => io::Error::new(io::ErrorKind::Other, "formatter error"),