class FileLogger

logger :: FileLogger

Log messages to a file

var log_file = "my_file.log"
var logger = new FileLogger(warn_level, log_file, append = false)
logger.error("An error")
logger.info("Some info")
logger.close
assert log_file.to_path.read_all == "An error\n"

logger = new FileLogger(warn_level, log_file, append = true)
logger.error("Another error")
logger.close
assert log_file.to_path.read_all == "An error\nAnother error\n"

log_file.to_path.delete

Introduced properties

fun append: Bool

logger :: FileLogger :: append

Append messages to file
protected fun append=(append: nullable Bool)

logger :: FileLogger :: append=

Append messages to file
fun close

logger :: FileLogger :: close

Close the logger and its file
init defaultinit(level: nullable Int, file: String, append: nullable Bool, default_formatter: nullable Formatter)

logger :: FileLogger :: defaultinit

fun file: String

logger :: FileLogger :: file

File where messages will be written
protected fun file=(file: String)

logger :: FileLogger :: file=

File where messages will be written

Redefined properties

redef type OUT: FileWriter

logger $ FileLogger :: OUT

Kind of Writer used to output messages
redef type SELF: FileLogger

logger $ FileLogger :: SELF

Type of this instance, automatically specialized in every class
redef init init

logger $ FileLogger :: init

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type OUT: Writer

logger :: Logger :: OUT

Kind of Writer used to output messages
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun add(level: Int, message: Writable, formatter: nullable Formatter): Bool

logger :: Logger :: add

Output a message with level severity
fun add_raw(level: Int, message: Writable): Bool

logger :: Logger :: add_raw

Output a message with level severity without formatting it
fun append: Bool

logger :: FileLogger :: append

Append messages to file
protected fun append=(append: nullable Bool)

logger :: FileLogger :: append=

Append messages to file
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun close

logger :: FileLogger :: close

Close the logger and its file
fun debug(message: String, formatter: nullable Formatter): Bool

logger :: Logger :: debug

Output a message with debug severity
fun default_formatter: nullable Formatter

logger :: Logger :: default_formatter

Formatter used to format messages before outputting them
fun default_formatter=(default_formatter: nullable Formatter)

logger :: Logger :: default_formatter=

Formatter used to format messages before outputting them
init defaultinit(level: nullable Int, file: String, append: nullable Bool, default_formatter: nullable Formatter)

logger :: FileLogger :: defaultinit

init defaultinit(level: nullable Int, out: nullable OUT, default_formatter: nullable Formatter)

logger :: Logger :: defaultinit

fun error(message: String, formatter: nullable Formatter): Bool

logger :: Logger :: error

Output a message with error_level severity
fun fatal(message: String, formatter: nullable Formatter): Bool

logger :: Logger :: fatal

Output a message with fatal_level severity
fun file: String

logger :: FileLogger :: file

File where messages will be written
protected fun file=(file: String)

logger :: FileLogger :: file=

File where messages will be written
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun info(message: String, formatter: nullable Formatter): Bool

logger :: Logger :: info

Output a message with info_level severity
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun level: Int

logger :: Logger :: level

Severity threshold
fun level=(level: nullable Int)

logger :: Logger :: level=

Severity threshold
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun out: OUT

logger :: Logger :: out

Writer used to output messages
protected fun out=(out: nullable OUT)

logger :: Logger :: out=

Writer used to output messages
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun unknown(message: String, formatter: nullable Formatter): Bool

logger :: Logger :: unknown

Output a message with unknown_level severity
fun warn(message: String, formatter: nullable Formatter): Bool

logger :: Logger :: warn

Output a message with warn_level severity
package_diagram logger::FileLogger FileLogger logger::Logger Logger logger::FileLogger->logger::Logger core::Object Object logger::Logger->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

class Logger

logger :: Logger

A simple logging utility

Class definitions

logger $ FileLogger 
# Log messages to a file
#
# ~~~
# var log_file = "my_file.log"
# var logger = new FileLogger(warn_level, log_file, append = false)
# logger.error("An error")
# logger.info("Some info")
# logger.close
# assert log_file.to_path.read_all == "An error\n"
#
# logger = new FileLogger(warn_level, log_file, append = true)
# logger.error("Another error")
# logger.close
# assert log_file.to_path.read_all == "An error\nAnother error\n"
#
# log_file.to_path.delete
# ~~~
class FileLogger
	super Logger
	autoinit level, file, append, default_formatter

	redef type OUT: FileWriter

	# File where messages will be written
	var file: String

	# Append messages to `file`
	#
	# If `append` is `false`, the `file` will be overwritten.
	var append: Bool = true is optional

	init do
		var old = null
		if append then
			old = file.to_path.read_all
		end
		out = new FileWriter.open(file)
		out.set_buffering_mode(0, buffer_mode_line)
		if old != null then
			out.write(old)
		end
	end

	# Close the logger and its `file`
	fun close do out.close
end
lib/logger/logger.nit:264,1--309,3
Nit standard library. Version v0.8-3595-g3f58b4f.