viernes, 18 de diciembre de 2015

Módulo file

file.remove()
Descripción
borra un archivo del sistema de ficheros.
Sintaxis
file.remove(filename)
Parámetros
filename: archivo a borrar
Devuelve
nada
Ejemplo
-- borra el archivo "foo.lua".
file.remove("foo.lua")
file.open()
Descripción
abre un archivo.
Sintaxis
file.open(filename, mode)
Parámetros
filename: archivo a abrir (no admite directorios)
mode:
  • "r": modo lectura (por defecto)
  • "w": modo escritura (sobreescribe el fichero existente)
  • "a": modo añadir (añade al texto existente)
  • "r+": modo actualizar (preserva los datos existentes)
  • "w+": modo actualizar (elimina los datos existentes)
  • "a+": modo añadir actualizado (preserva los datos existentes y añade al final del archivo)

 
Devuelve
nil: archivo no abierto o no existe. true: archivo abierto correctamente.
Ejemplo
-- abre el archivo 'init.lua', muestra la primera línea.
file.open("init.lua", "r")
print(file.readline())
file.close()
file.close()
Descripción
cierra un archivo.
Sintaxis
file.close()
Parámetros
ninguno
Devuelve
nada
Ejemplo
-- abre 'init.lua', muestra la primera línea.
file.open("init.lua", "r")
print(file.readline())
file.close()
file.readline()
Descripción
lee una línea de un archivo abierto previamente.
Sintaxis
file.readline()
Parámetros
ninguno
Devuelve
contenido del archivo en formato string, línea a línea, incluido EOL (End Of Line)('\n')
devuelve nil cuando se llega al final del archivo (EOF - End Of File).
Ejemplo
-- muestra la primera línea de 'init.lua'
file.open("init.lua", "r")
print(file.readline())
file.close()
file.writeline()
Descripción
escribe un string en el archivo incluyendo '\n' al final del string.
Sintaxis
file.writeline(string)
Parámetros
string: contenido que se escribirá en el archivo
Devuelve
true: escritura correcta. nil: error de escritura
Ejemplo
-- abre 'init.lua' en modo 'a+'
file.open("init.lua", "a+")
-- escribe 'foo bar' al final del archivo
file.writeline('foo bar')
file.close()
file.read()
Descripción
lee el contenido del archivo abierto previamente.
Sintaxis
file.read()
Parámetros
si no se incluye ninguno, lee todos los bytes del archivo.
si pasamos un número  n, lee n byte del archivo, o hasta que llegue al final del fichero (EOF)
si pasamos un string "q", entonces lle hasta  'q' o final del fichero (EOF).
Devuelve
el contenido del archivo en formato string
devuelve nil cuando EOF.
Ejemplo
-- muestra la primera línea de 'init.lua'
file.open("init.lua", "r")
print(file.read('\r'))
file.close()

-- muestra los primeros 5 byte de 'init.lua'
file.open("init.lua", "r")
print(file.read(5))
file.close()
file.write()
Descripción
escribe string en un archivo.
Sintaxis
file.write(string)
Parámetros
string: contenido que se escribirá en el archivo.
Devuelve
true: escritura correcta. nil: error de escritura
Ejemplo
-- abre 'init.lua' en modo 'a+’
file.open("init.lua", "a+")
-- escribe 'foo bar' al final del fichero
file.write('foo bar')
file.close()
file.flush()
Descripción
flush to file.
Sintaxis
file.flush()
Parámetros
ninguno
Devuelve
nada
Ejemplo
-- abren 'init.lua' en modo 'a+'
file.open("init.lua", "a+")
-- escribe 'foo bar' al final del archivo
file.write('foo bar')
file.flush()
file.close()
file.seek()
Descripción
Sets and gets the file position, measured from the beginning of the file, to the position given by offset plus a base specified by the string whence.
Se establece y obtiene la posición del fichero, medido desde su inicio a la posición especificada.
Sintaxis
file.seek(whence, offset)
Parámetros
whence:
  • "set": tomo como base la posición 0 (comienzo del archivo);
  • "cur": toma como base la posición actual (valor por defecto)
  • "end": toma como base el final del fichero;
offset: por defecto 0
Devuelve
sucede correctamente: devuelve la posición final del archivo
fallo: devuelve nil
Ejemplo
-- abre 'init.lua' en modo 'a+
file.open("init.lua", "a+")
-- escribe 'foo bar' al final del archivo
file.write('foo bar')
file.flush()
file.seek("set")
print(file.readline())
file.close()
file.list()
Descripción
lista todos los archivos.
Sintaxis
file.list()
Parámetros
ninguno
Devuelve
una tabla lua que contiene pares de {nombre archivo: tamaño archivo}
Ejemplo
l = file.list();
for k,v in pairs(l) do
   print("name:"..k..", size:"..v)
end
file.format()
Descripción
formatea el sistema de archivos.
Sintaxis
file.format()
Parámetros
ninguno
Devuelve
nada
Ejemplo
file.format()
file.rename()
Descripción
renombre un archivo. NOTA: el archivo actualmente abierto se cerrará
Sintaxis
file.rename(oldname, newname)
Parámetros
oldname: nombre viejo, directorios no soportados
newname: nuevo nombre, directorios no soportados
Devuelve
false: fallo en el renombre. true: renombrado ok.
Ejemplo
-- renombra el archivo 'temp.lua' a 'init.lua'.
file.rename("temp.lua","init.lua")
file.fsinfo()
Descripción
obtiene información del sistema de archivos
Sintaxis
file.fsinfo()
Parámetros
ninguno
Devuelve
restante (número)
usado (number)
total (number)
Ejemplo
-- obtiene información del sistema de archivos
remaining, used, total=file.fsinfo()
print("\nFile system info:\nTotal : "..total.." Bytes\nUsed : "..used.."
Bytes\nRemain: "..remaining.." Bytes\n")

No hay comentarios:

Publicar un comentario

Nota: solo los miembros de este blog pueden publicar comentarios.