Skip to main content

purpose

Function purpose 

Source
pub fn purpose(
    target: &Utf8Path,
    config: Option<&Config>,
    recorded: bool,
) -> Result<Purpose, RkError>
Expand description

The purpose a stage resolves its answers under.

It is the purpose of the landing verb that follows, so the stage previews that verb’s defaults and refusals rather than another verb’s. A recorded target is upgraded; one rk status classifies as adopt is adopted, by the same precedence, so an open migration that keeps a marked block still lands as a first landing; anything else is one.

§Errors

RkError::Io where the adoption detector cannot read the target.