Struct pm_options

#[repr(C)]
pub struct pm_options {

    pub shebang_callback: pm_options_shebang_callback_t,
    pub shebang_callback_data: *mut c_void,
    pub filepath: pm_string_t,
    pub line: i32,
    pub encoding: pm_string_t,
    pub scopes_count: usize,
    pub scopes: *mut pm_options_scope_t,
    pub version: pm_options_version_t,
    pub command_line: u8,
    pub frozen_string_literal: i8,
    pub encoding_locked: bool,
    pub main_script: bool,
    pub partial_script: bool,
    pub freeze: bool,
}

Forward declaration needed by the callback typedef.

Fields

shebang_callback: pm_options_shebang_callback_t

The callback to call when additional switches are found in a shebang comment.

shebang_callback_data: *mut c_void

Any additional data that should be passed along to the shebang callback if one was set.

filepath: pm_string_t

The name of the file that is currently being parsed.

line: i32

The line within the file that the parse starts on. This value is 1-indexed.

encoding: pm_string_t

The name of the encoding that the source file is in. Note that this must correspond to a name that can be found with Encoding.find in Ruby.

scopes_count: usize

The number of scopes surrounding the code that is being parsed.

scopes: *mut pm_options_scope_t

The scopes surrounding the code that is being parsed. For most parses this will be NULL, but for evals it will be the locals that are in scope surrounding the eval. Scopes are ordered from the outermost scope to the innermost one.

version: pm_options_version_t

The version of prism that we should be parsing with. This is used to allow consumers to specify which behavior they want in case they need to parse exactly as a specific version of CRuby.

command_line: u8

A bitset of the various options that were set on the command line.

frozen_string_literal: i8

Whether or not the frozen string literal option has been set. May be:

• PM_OPTIONS_FROZEN_STRING_LITERAL_DISABLED
• PM_OPTIONS_FROZEN_STRING_LITERAL_ENABLED
• PM_OPTIONS_FROZEN_STRING_LITERAL_UNSET

encoding_locked: bool

Whether or not the encoding magic comments should be respected. This is a niche use-case where you want to parse a file with a specific encoding but ignore any encoding magic comments at the top of the file.

main_script: bool

When the file being parsed is the main script, the shebang will be considered for command-line flags (or for implicit -x). The caller needs to pass this information to the parser so that it can behave correctly.

partial_script: bool

When the file being parsed is considered a “partial” script, jumps will not be marked as errors if they are not contained within loops/blocks. This is used in the case that you’re parsing a script that you know will be embedded inside another script later, but you do not have that context yet. For example, when parsing an ERB template that will be evaluated inside another script.

freeze: bool

Whether or not the parser should freeze the nodes that it creates. This makes it possible to have a deeply frozen AST that is safe to share between concurrency primitives.

Trait Implementations

impl Clone for pm_options

fn clone(&self) -> pm_options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for pm_options

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

Formats the value using the given formatter.

impl Default for pm_options

fn default() -> Self

Returns the “default value” for a type.

impl Copy for pm_options