pub struct Engine {
pub project: Project,
/* private fields */
}Fields§
§project: ProjectImplementations§
Source§impl Engine
impl Engine
pub fn new(root: &Path, opts: Options) -> Engine
Sourcepub fn take_private_blocked(&self) -> Vec<PrivateRequired>
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.
pub fn root(&self) -> &Path
Sourcepub fn fetch_all(&self, package: Option<&str>) -> Result<Answer, String>
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.
Sourcepub fn warm(&self, package: Option<&str>) -> Result<Answer, String>
pub fn warm(&self, package: Option<&str>) -> Result<Answer, String>
Build (or load) indexes ahead of time and report what they hold.
pub fn resolve(&self, filter: Option<&str>) -> Answer
Sourcepub fn upgrade_report(
&self,
package: &str,
target: &str,
tokens: usize,
) -> Result<Answer, String>
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).
pub fn docs( &self, package: Option<&str>, query: &str, tokens: usize, ) -> Result<Answer, String>
pub fn api( &self, symbol: &str, package: Option<&str>, tokens: usize, ) -> Result<Answer, String>
Auto Trait Implementations§
impl !Freeze for Engine
impl RefUnwindSafe for Engine
impl Send for Engine
impl Sync for Engine
impl Unpin for Engine
impl UnsafeUnpin for Engine
impl UnwindSafe for Engine
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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