index :: path

path.file

file input/output

available since version: 0.9.5

---

methods:

• close close file
  

• open open file, updates @path property
  parameters:

  • FNAME file path: absolute or relative
    type: symbol
    required: True
    

  • [MODE] open mode, 'r': open text file for reading only. 'w': truncate to 0 length, if existent, or create text file for writing only. 'a': append, open or create text file only for writing at end of file. 'r+': open text file for reading and writing. 'w+': truncate to 0 length, if existent, or create text file for reading and writing. 'a+': append, open or create text file for reading and writing, writing at end of file
    type: symbol
    

• read_bytes read bytes from file, output as list of integers
  parameters:
  • [N] number of bytes to read, if omitted read all content
    type: int
    

• read_line read line from file, output as list as atoms
  

• remove remove file
  parameters:
  • NAME file path
    type: symbol
    required: True
    
• rename rename file
  parameters:

  • PATH old file path
    type: symbol
    required: True
    

  • NEW_PATH new file path
    type: symbol
    required: True
    

• seek_read change reading position
  parameters:

  • POS offset position
    type: int
    required: True
    

  • [ORIG] offset origin, if omitted offset from the beginning
    type: symbol
    

• seek_write change writing position
  parameters:

  • POS offset position
    type: int
    required: True
    

  • [ORIG] offset origin, if omitted offset from the beginning
    type: symbol
    

• write write space separated atoms to file, no newline added
  parameters:
  • ARGS atoms to write
    type: list
    required: True
    
• write_bytes write given bytes to file
  parameters:
  • ARGS list of bytes: integers in 0-255 or symbols with '0x' prefix: 0x11, 0xFF etc..
    type: list
    required: True
    
• write_line write space separated atoms to file, newline added
  parameters:
  • ARGS atoms to write
    type: list
    required: True
    

properties:

• @path Get/set file path
  type: symbol
  

inlets:

• …
  type: control

outlets:

• list: read output
  type: control
• bang on EOF reached
  type: control

keywords:

path file

Authors: Serge Poltavsky

License: GPL3 or later