Struct libojo::File

pub struct File { /* fields omitted */ }

A File is a special case of a Graggle, in which there is just a linear order.

This struct offers convenient (read-only) access to a File, allowing the contents and ids of nodes to be access by indexing.

The most convenient way to get a File is through Repo::file, but they can also be built from raw bytes (using File::from_bytes).

Methods

impl File

pub fn from_bytes(bytes: &[u8]) -> File

Creates a File from the raw bytes, by dividing them into lines.

The NodeIds will be synthesized: they will have empty PatchIds, and their node indices will be consecutive, starting from zero.

pub fn num_nodes(&self) -> usize

How many nodes does this file have?

Currently, "nodes" is synonymous with "lines", but that may not necessarily be the case in the future (for example, we could diff files based on words instead of lines).

pub fn node(&self, idx: usize) -> &[u8]

Gets the contents of the node at the given index. This includes the \n character, if there was one.

pub fn node_id(&self, idx: usize) -> &NodeId

Gets the id of the node at the given index.

pub fn as_bytes(&self) -> &[u8]

Gets the whole file, as an array of bytes.

Trait Implementations

impl PartialEq<File> for File

fn eq(&self, other: &File) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &File) -> bool

This method tests for !=.

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for File

impl Debug for File

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

Formats the value using the given formatter.