Skip to main content

Exporter

Struct Exporter 

Source
pub struct Exporter<'a, S: Sink> { /* private fields */ }
Expand description

Streams an Env in lean4export 3.1.0 order to a Sink, NDJSON by default. Ids are assigned on first use and every record only refers to records already written.

Implementations§

Source§

impl<'a, W: Write> Exporter<'a, Ndjson<W>>

Source

pub fn new(env: &'a Env, out: W) -> Self

Source§

impl<'a, S: Sink> Exporter<'a, S>

Source

pub fn with_sink(env: &'a Env, sink: S) -> Self

Source

pub fn resume(env: &'a Env, sink: S, mark: Mark) -> Result<Self>

Continue the export mark was taken from, on the same environment.

Source

pub fn per_module(env: &'a Env, sink: S) -> Self

An exporter that writes one module at a time with Exporter::module, each to its own sink after Exporter::split. A module’s records refer to what its imports declare by name only.

Source

pub fn restricted(env: &'a Env, sink: S) -> Self

Like Exporter::per_module, but an import provides only what Lean showed of it.

Source

pub fn module(&mut self, m: usize) -> Result<()>

Write every constant module m declares. Internal ones are included, since a later module may need them.

Source

pub fn interface(&mut self, m: usize) -> Result<()>

Write what module m exports.

Source

pub fn inside(&self, m: usize) -> impl Iterator<Item = usize> + '_

The modules m sees all of.

Source

pub fn split(&mut self, sink: S) -> Result<S::Output>

End the current file and start the next on sink, with ids from the start again. Returns the finished sink’s output.

Source

pub const fn statements(self) -> Self

Write every theorem as an axiom over its type, so an environment from Env::load_statements exports its statements and what they rest on, with no proofs.

Source

pub fn meta(&mut self) -> Result<()>

Source

pub fn meta_with(&mut self, module: Option<Value>) -> Result<()>

The meta record, with module added under that key when given.

Source

pub fn all(&mut self) -> Result<()>

Export every non-internal constant in load order, like lean4export with no --.

Source

pub const fn counts(&self) -> Counts

Source

pub fn finish(self) -> Result<S::Output>

Write the end record and hand back the sink’s output.

Source

pub fn suspend(self) -> Result<(S::Output, Mark)>

Like Exporter::finish, with a Mark to Exporter::resume from.

Source

pub fn update(&mut self, r: &Reload) -> Result<()>

After Env::reload, export the reloaded constants again as Exporter::all would. The end record counts every record since the first export. An internal constant is written again if it was written before, since terms already scanned will not lead back to it.

Source

pub fn constant(&mut self, c: NameId) -> Result<()>

Export a constant and, first, everything it mentions. Dependencies are walked depth-first on an explicit stack, so no term depth or dependency chain can overflow the thread’s stack.

Trait Implementations§

Source§

impl<'a, S: Debug + Sink> Debug for Exporter<'a, S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, S> Forget for Exporter<'a, S>

§

impl<'a, S> Freeze for Exporter<'a, S>
where S: Freeze,

§

impl<'a, S> Move for Exporter<'a, S>

§

impl<'a, S> RefUnwindSafe for Exporter<'a, S>
where S: RefUnwindSafe,

§

impl<'a, S> Send for Exporter<'a, S>
where S: Send,

§

impl<'a, S> Sync for Exporter<'a, S>
where S: Sync,

§

impl<'a, S> Unpin for Exporter<'a, S>
where S: Unpin,

§

impl<'a, S> UnsafeUnpin for Exporter<'a, S>
where S: UnsafeUnpin,

§

impl<'a, S> UnwindSafe for Exporter<'a, S>
where S: UnwindSafe,

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, U> ExactFrom<T> for U
where U: TryFrom<T>,

Source§

fn exact_from(value: T) -> U

Source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

Source§

fn exact_into(self) -> U

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, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

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, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

Source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

Source§

impl<T> ToDebugString for T
where T: Debug,

Source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

Source§

fn wrapping_into(self) -> U