Namespace: go.std.io.ioutil

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the io/ioutil package.

Package ioutil implements some I/O utility functions.

As of Go 1.16, the same functionality is now provided
by package io or package os, and those implementations
should be preferred in new code.
See the specific function documentation for details.

Index

• Discard
• NopCloser
• ReadAll
• ReadDir
• ReadFile
• TempDir
• TempFile
• WriteFile

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

Variables

• Discard

  Var v1.0

  Discard is an io.Writer on which all Write calls succeed
  without doing anything.
  
  As of Go 1.16, this value is simply io.Discard.
  

Functions, Macros, and Special Forms

• NopCloser

  Function v1.0

  (NopCloser r)
  

  NopCloser returns a ReadCloser with a no-op Close method wrapping
  the provided Reader r.
  
  As of Go 1.16, this function simply calls io.NopCloser.
  
  Go input arguments: (r io.Reader)
  
  Go returns: io.ReadCloser
  
  Joker input arguments: [^go.std.io/Reader r]
  
  Joker returns: ^go.std.io/ReadCloser

• ReadAll

  Function v1.0

  (ReadAll r)
  

  ReadAll reads from r until an error or EOF and returns the data it read.
  A successful call returns err == nil, not err == EOF. Because ReadAll is
  defined to read from src until EOF, it does not treat an EOF from Read
  as an error to be reported.
  
  As of Go 1.16, this function simply calls io.ReadAll.
  
  Go input arguments: (r io.Reader)
  
  Go returns: ([]byte, error)
  
  Joker input arguments: [^go.std.io/Reader r]
  
  Joker returns: [^arrayOfByte, ^Error]

• ReadDir

  Function v1.0

  (ReadDir dirname)
  

  ReadDir reads the directory named by dirname and returns
  a list of fs.FileInfo for the directory's contents,
  sorted by filename. If an error occurs reading the directory,
  ReadDir returns no directory entries along with the error.
  
  As of Go 1.16, os.ReadDir is a more efficient and correct choice:
  it returns a list of fs.DirEntry instead of fs.FileInfo,
  and it returns partial results in the case of an error
  midway through reading a directory.
  
  Go input arguments: (dirname string)
  
  Go returns: ([]io/fs.FileInfo, error)
  
  Joker input arguments: [^String dirname]
  
  Joker returns: [^go.std.io.fs/arrayOfFileInfo, ^Error]

• ReadFile

  Function v1.0

  (ReadFile filename)
  

  ReadFile reads the file named by filename and returns the contents.
  A successful call returns err == nil, not err == EOF. Because ReadFile
  reads the whole file, it does not treat an EOF from Read as an error
  to be reported.
  
  As of Go 1.16, this function simply calls os.ReadFile.
  
  Go input arguments: (filename string)
  
  Go returns: ([]byte, error)
  
  Joker input arguments: [^String filename]
  
  Joker returns: [^arrayOfByte, ^Error]

• TempDir

  Function v1.0

  (TempDir dir pattern)
  

  TempDir creates a new temporary directory in the directory dir.
  The directory name is generated by taking pattern and applying a
  random string to the end. If pattern includes a "*", the random string
  replaces the last "*". TempDir returns the name of the new directory.
  If dir is the empty string, TempDir uses the
  default directory for temporary files (see os.TempDir).
  Multiple programs calling TempDir simultaneously
  will not choose the same directory. It is the caller's responsibility
  to remove the directory when no longer needed.
  
  As of Go 1.17, this function simply calls os.MkdirTemp.
  
  Go input arguments: (dir string, pattern string)
  
  Go returns: (name string, err error)
  
  Joker input arguments: [^String dir, ^String pattern]
  
  Joker returns: [^String name, ^Error err]

• TempFile

  Function v1.0

  (TempFile dir pattern)
  

  TempFile creates a new temporary file in the directory dir,
  opens the file for reading and writing, and returns the resulting *os.File.
  The filename is generated by taking pattern and adding a random
  string to the end. If pattern includes a "*", the random string
  replaces the last "*".
  If dir is the empty string, TempFile uses the default directory
  for temporary files (see os.TempDir).
  Multiple programs calling TempFile simultaneously
  will not choose the same file. The caller can use f.Name()
  to find the pathname of the file. It is the caller's responsibility
  to remove the file when no longer needed.
  
  As of Go 1.17, this function simply calls os.CreateTemp.
  
  Go input arguments: (dir string, pattern string)
  
  Go returns: (f *os.File, err error)
  
  Joker input arguments: [^String dir, ^String pattern]
  
  Joker returns: [^go.std.os/*File f, ^Error err]

• WriteFile

  Function v1.0

  (WriteFile filename data perm)
  

  WriteFile writes data to a file named by filename.
  If the file does not exist, WriteFile creates it with permissions perm
  (before umask); otherwise WriteFile truncates it before writing, without changing permissions.
  
  As of Go 1.16, this function simply calls os.WriteFile.
  
  Go input arguments: (filename string, data []byte, perm io/fs.FileMode)
  
  Go returns: error
  
  Joker input arguments: [^String filename, ^arrayOfByte data, ^go.std.io.fs/FileMode perm]
  
  Joker returns: ^Error

Types

(None.)