Idris2Doc : FS.Posix

FS.Posix

(source)

Reexports

importpublic IO.Async.Posix
importpublic FS
importpublic System.Posix.Dir
importpublic System.Posix.File.Stats
importpublic System.Posix.File.Type
importpublic System.Posix.File

Definitions

recordEntry : PathType->Type
Totality: total
Visibility: public export
Constructor: 
E : Pathp->FileType->FileStats->Entryp

Projections:
.path : Entryp->Pathp
.stats : Entryp->FileStats
.type : Entryp->FileType

Hints:
Eq (Entryp)
Show (Entryp)
.path : Entryp->Pathp
Totality: total
Visibility: public export
path : Entryp->Pathp
Totality: total
Visibility: public export
.type : Entryp->FileType
Totality: total
Visibility: public export
type : Entryp->FileType
Totality: total
Visibility: public export
.stats : Entryp->FileStats
Totality: total
Visibility: public export
stats : Entryp->FileStats
Totality: total
Visibility: public export
hidden : Entryp->Bool
  True if the given directory entry is hidden.

Totality: total
Visibility: export
regular : Entryp->Bool
  True if the given directory entry is a regular file

Totality: total
Visibility: export
regularExt : Body->Entryp->Bool
  True if the given directory entry is a regular file
with the given extension.

Totality: total
Visibility: export
entries_ : HasErrnoes=>Bool->Dir->AsyncStreameesString
  Produces a stream of directory entries.

This is a low-level utility to just emit the content of a directory.
Use `entries` to get proper file paths and information about the types
and stats of files.

Totality: total
Visibility: export
entries : HasErrnoes=>Pathp->AsyncStreamees (Entryp)
  Produces a stream of directory entries.

This will not include the parent directory `".."` in the output.

Totality: total
Visibility: export
deepEntries : HasErrnoes=>Pathp->AsyncStreamees (Entryp)
  Like entries but also enters child directories.

Totality: total
Visibility: export
bytesRaw : PollHe=>HasErrnoes=>FileDesca=>a->Buf->AsyncStreameesEMBuffer
  Streams chunks of bytes into a pre-allocated buffer.

This uses non-blocking I/O, so it can also be used for reading from pipes
such as standard input.

Totality: total
Visibility: export
bytes : PollHe=>HasErrnoes=>FileDesca=>a->Bits32->AsyncStreameesByteString
  Streams chunks of byte of at most the given size from the given
file descriptor.

This uses non-blocking I/O, so it can also be used for reading from pipes
such as standard input.

Totality: total
Visibility: export
bytesPtr : PollHe=>HasErrnoes=>FileDesca=>a->CPtr->AsyncStreameesByteString
  Like `bytes` but allows us to reuse a pre-allocated C-pointer.

Totality: total
Visibility: export
readBytes : PollHe=>HasErrnoes=> {default65535_ : Bits32} ->String->AsyncStreameesByteString
  Tries to open the given file and starts reading chunks of bytes
from the created file descriptor.

Totality: total
Visibility: export
readRawBytes : PollHe=>HasErrnoes=>Buf->String->AsyncStreameesEMBuffer
  Tries to open the given file and starts reading chunks of bytes
from the created file descriptor.

Totality: total
Visibility: export
content : PollHe=>HasErrnoes=>Entryp->AsyncStreameesByteString
  Streams the content of a directory entry

Totality: total
Visibility: export
writeTo : PollHe=>HasErrnoes=>ToBufo=>FileDesca=>a->AsyncPulleoesr->AsyncPulleVoidesr
Totality: total
Visibility: export
printLnTo : PollHe=>HasErrnoes=>Showo=>FileDesca=>a->AsyncPulleoesr->AsyncPulleVoidesr
Totality: total
Visibility: export
printLnsTo : PollHe=>HasErrnoes=>Showo=>FileDesca=>a->AsyncPulle (Listo) esr->AsyncPulleVoidesr
Totality: total
Visibility: export
printTo : PollHe=>HasErrnoes=>Showo=>FileDesca=>a->AsyncPulleoesr->AsyncPulleVoidesr
Totality: total
Visibility: export
writeFile : PollHe=>HasErrnoes=>ToBufo=>String->AsyncPulleoesr->AsyncPulleVoidesr
Totality: total
Visibility: export
appendFile : PollHe=>HasErrnoes=>ToBufo=>String->AsyncPulleoesr->AsyncPulleVoidesr
Totality: total
Visibility: export