logo
pub enum Required {
    Success,
    AlreadyRequired,
}
Expand description

The side effect from a call to Kernel#require.

In Ruby, require is stateful. All required sources are tracked in a global interpreter state accessible as $" and $LOADED_FEATURES.

The first time a file is required, it is parsed and executed by the interpreter. If the file executes without raising an error, the file is successfully required and Rust callers can expect a Required::Success variant. Files that are successfully required are added to the interpreter’s set of loaded features.

If the file raises an exception as it is required, Rust callers can expect an Err variant. The file is not added to the set of loaded features.

If the file has previously been required such that Required::Success has been returned, all subsequent calls to require the file will return Required::AlreadyRequired.

See the documentation of require_source for more details.

Variants

Success

Kernel#require succeeded at requiring the file.

If this variant is returned, this is the first time the given file has been required in the interpreter.

This variant has value true when converting to a Boolean as returned by Kernel#require.

AlreadyRequired

Kernel#require did not require the file because it has already been required.

If this variant is returned, this is at least the second time the given file has been required. Interpreters guarantee that files are only required once. To load a source multiple times, see load_source and Kernel#load.

This variant has value false when converting to a Boolean as returned by Kernel#require.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Convert a Required enum into a bool as returned by Kernel#require.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.