Class: SleepingKingStudios::Docs::Errors::FileError

Inherits:

Cuprum::Error

• Object
• Cuprum::Error
• SleepingKingStudios::Docs::Errors::FileError

Defined in:

lib/sleeping_king_studios/docs/errors/file_error.rb

Overview

Abstract base class for errors interacting with the file system.

Direct Known Subclasses

FileAlreadyExists, FileNotFound, InvalidDirectory, InvalidFile

Constant Summary

TYPE =

Short string used to identify the type of error.

'sleeping_king_studios.docs.errors.file_error'

Instance Attribute Summary

• #path ⇒ String readonly

  The invalid file or directory path.

Instance Method Summary

• #initialize(message:, path:) ⇒ FileError constructor

  A new instance of FileError.

Constructor Details

#initialize(message:, path:) ⇒ FileError

Returns a new instance of FileError.

Parameters:

• message (String) —

  message describing the nature of the error.

• path (String) —

  the invalid file or directory path.

# File 'lib/sleeping_king_studios/docs/errors/file_error.rb', line 15

def initialize(message:, path:)
  super(message:)

  @path = path
end

Instance Attribute Details

#path ⇒ String (readonly)

Returns the invalid file or directory path.

Returns:

• (String) —

  the invalid file or directory path.

# File 'lib/sleeping_king_studios/docs/errors/file_error.rb', line 22

def path
  @path
end