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

Parent Namespace

SleepingKingStudios::Docs::Errors

Inherited Classes

Cuprum::Error > Object

Defined In

lib/sleeping_king_studios/docs/errors/file_error.rb

Table Of Contents

• Overview
• Direct Subclasses
• Constants
  • TYPE
• Constructor
• Instance Attributes
  • path
• Instance Methods
  • initialize

Overview

Abstract base class for errors interacting with the file system.

Back To Top

Direct Subclasses

SleepingKingStudios::Docs::Errors::FileAlreadyExists, SleepingKingStudios::Docs::Errors::FileNotFound, SleepingKingStudios::Docs::Errors::InvalidDirectory, SleepingKingStudios::Docs::Errors::InvalidFile

Back To Top

Constants

TYPE

= 'sleeping_king_studios.docs.errors.file_error'

Short string used to identify the type of error.

Back To Top

Constructor

#initialize(message:, path:) => FileError

Parameters

• message (String) — message describing the nature of the error.
• path (String) — the invalid file or directory path.

Returns

• (FileError) — a new instance of FileError

Back To Top

Instance Attributes

#path => String (readonly)

Returns

• (String) — the invalid file or directory path.

Back To Top

Instance Methods

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Errors