Struct CodeToPdf

Source
pub struct CodeToPdf { /* private fields */ }
Expand description

Main struct for generating PDFs. It handles almost the entire process of reading and highlighting code, as well as actually writing it to the PDF

Implementations§

Source§

impl CodeToPdf

Source

pub fn new( doc: Arc<Mutex<DocumentSubset>>, font_id: FontId, page_dimensions: Dimensions, text_wrapper: TextWrapper, page_text: Option<ProcessedText>, include_path: bool, ) -> Self

Initialises a new CodeToPdf

Source

pub fn process_file( &mut self, file: &Path, highlighter_config: &HighlighterConfig, index: usize, ) -> Result<(), Box<dyn Error>>

Generates pages for a file

Source

pub fn process_files( &mut self, walker: Walk, highlighter_config: HighlighterConfig, )

Consumes entire walker

Source

pub fn processed_file_count(&self) -> usize

Returns number of files processed by CodeToPdf::process_files

Source§

impl CodeToPdf

Source

pub fn run_parallel( font_id: FontId, font_bytes: &[u8], path: PathBuf, exclusions: Vec<String>, page_dimensions: Dimensions, font_size: f32, page_text: Option<String>, include_path: bool, threads: Option<NonZeroU8>, ) -> (Arc<Mutex<DocumentSubset>>, usize)

Helper function that handles everything for the basic use-case

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> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.