Skip to main content

Engine

Struct Engine 

Source
pub struct Engine {
    pub project: Project,
    /* private fields */
}

Fields§

§project: Project

Implementations§

Source§

impl Engine

Source

pub fn new(root: &Path, opts: Options) -> Engine

Source

pub fn take_private_blocked(&self) -> Vec<PrivateRequired>

The packages that needed a private source without Pro since the last call. The binary turns a non-empty list into the pro_required answer.

Source

pub fn root(&self) -> &Path

Source

pub fn fetch_all(&self, package: Option<&str>) -> Result<Answer, String>

lockdocs fetch: download what makes answers complete, once: missing packages at their pinned versions, upstream docs at each version’s git tag, and the embedding model.

Source

pub fn warm(&self, package: Option<&str>) -> Result<Answer, String>

Build (or load) indexes ahead of time and report what they hold.

Source

pub fn resolve(&self, filter: Option<&str>) -> Answer

Source

pub fn upgrade_report( &self, package: &str, target: &str, tokens: usize, ) -> Result<Answer, String>

Upgrade report (lockdocs Pro; the caller checks the licence): the API difference between the pinned version of package and target, limited to symbols this project uses. The target version is read from the same sources as any other version (installed, cached, or fetched when fetching is enabled).

Source

pub fn docs( &self, package: Option<&str>, query: &str, tokens: usize, ) -> Result<Answer, String>

Source

pub fn api( &self, symbol: &str, package: Option<&str>, tokens: usize, ) -> Result<Answer, String>

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> 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 = !

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.