class Prism::MagicComment - Documentation for Ruby 3.4
Description: class Prism::MagicComment: This represents a magic comment that was encountered during parsing.
Keywords: ruby,class,Prism::MagicComment

# class Prism::MagicComment

This represents a magic comment that was encountered during parsing.

### Attributes

key_loc [R]

A `Location` object representing the location of the key in the source.

value_loc [R]

A `Location` object representing the location of the value in the source.

### Public Class Methods

new (key_loc, value_loc)
Source

    # File lib/prism/parse_result.rb, line 583
    def initialize(key_loc, value_loc)
      @key_loc = key_loc
      @value_loc = value_loc
    end

Create a new magic comment object with the given key and value locations.

### Public Instance Methods

deconstruct_keys (keys)
Source

    # File lib/prism/parse_result.rb, line 599
    def deconstruct_keys(keys)
      { key_loc: key_loc, value_loc: value_loc }
    end

Implement the hash pattern matching interface for `MagicComment`.

inspect ()
Source

    # File lib/prism/parse_result.rb, line 604
    def inspect
      "#<Prism::MagicComment @key=#{key.inspect} @value=#{value.inspect}>"
    end

Returns a string representation of this magic comment.

key ()
Source

    # File lib/prism/parse_result.rb, line 589
    def key
      key_loc.slice
    end

Returns the key of the magic comment by slicing it from the source code.

value ()
Source

    # File lib/prism/parse_result.rb, line 594
    def value
      value_loc.slice
    end

Returns the value of the magic comment by slicing it from the source code.