document some IO errors

Author: moritz

lib/X/IO.pod

@@ -0,0 +1,11 @@
+=begin pod
+
+=TITLE role X::IO
+
+    role X::IO does X::OS {}
+
+Common role for IO related errors.
+
+This role does not provide any additional methods.
+
+=end pod

lib/X/IO/Copy.pod

@@ -0,0 +1,21 @@
+=begin pod
+
+=TITLE class X::IO::Copy
+
+    class X::IO::Copy does X::IO is Exception { }
+
+Error class for failed file copy operations. A typical error message is
+
+    Failed to copy 'source' to 'destination': permission denied
+
+=head1 Methods
+
+=head2 from
+
+Returns the source of the failed copy operation
+
+=head2 to
+
+Returns the destination of the failed copy operation
+
+=end pod

lib/X/IO/Mkdir.pod

@@ -0,0 +1,23 @@
+=begin pod
+
+=TITLE class X::IO::Mkdir
+
+    class X::IO::Mkdir does X::IO is Exception
+
+Error class for failed L<mkdir> operations.
+
+A typical error message is
+
+    Failed to create directory 'destination' with mode '0o755': File exists
+
+=head1 Methods
+
+=head2 path
+
+Returns the path that the L<mkdir> operation failed to create.
+
+=head2 mode
+
+Returns the permissions mask of the failed L<mkdir> operation as an L<Int>.
+
+=end pod

lib/X/IO/Rename.pod

@@ -0,0 +1,22 @@
+=begin pod
+
+=TITLE class X::IO::Rename
+
+    class X::IO::Rename does X::IO is Exception { }
+
+Error class for failed file or directory rename operations. A typical
+error message is
+
+    Failed to rename 'source' to 'destination': is a directory
+
+=head1 Methods
+
+=head2 from
+
+Returns the source of the failed rename operation
+
+=head2 to
+
+Returns the destination of the failed rename operation
+
+=end pod

lib/X/OS.pod

@@ -0,0 +1,19 @@
+=begin pod
+
+=TITLE role X::OS
+
+    role X::OS { has $.os-error }
+
+Common role for all errors that are triggered by some error
+reported by the operating system (failed IO, system calls,
+fork, memory allocation).
+
+=head1 Methods
+
+=head2 os-error
+
+    method os-error() returns Str:D
+
+Returns the error as reported by the operating system.
+
+=end pod