Update RBI files for logger.

Autogenerated by the [vendor-gems](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/vendor-gems.yml) workflow.
This commit is contained in:
BrewTestBot 2024-09-04 16:56:49 +00:00 committed by Patrick Linnane
parent 3d815d0c2f
commit 62273bdcd5
No known key found for this signature in database

View File

@ -133,7 +133,7 @@
# when the entry is created.
#
# The logged timestamp is formatted by method
# {Time#strftime}[rdoc-ref:Time#strftime]
# {Time#strftime}[https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime]
# using this format string:
#
# '%Y-%m-%dT%H:%M:%S.%6N'
@ -350,7 +350,9 @@
# You can set a different format using create-time option
# +shift_period_suffix+;
# see details and suggestions at
# {Time#strftime}[rdoc-ref:Time#strftime].
# {Time#strftime}[https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime].
#
# source://logger//lib/logger/version.rb#3
class Logger
include ::Logger::Severity
@ -398,11 +400,14 @@ class Logger
# - +shift_period_suffix+: sets the format for the filename suffix
# for periodic log file rotation; default is <tt>'%Y%m%d'</tt>.
# See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
# - +reraise_write_errors+: An array of exception classes, which will
# be reraised if there is an error when writing to the log device.
# The default is to swallow all exceptions raised.
#
# @return [Logger] a new instance of Logger
#
# source://logger//logger.rb#578
def initialize(logdev, shift_age = T.unsafe(nil), shift_size = T.unsafe(nil), level: T.unsafe(nil), progname: T.unsafe(nil), formatter: T.unsafe(nil), datetime_format: T.unsafe(nil), binmode: T.unsafe(nil), shift_period_suffix: T.unsafe(nil)); end
# source://logger//lib/logger.rb#581
def initialize(logdev, shift_age = T.unsafe(nil), shift_size = T.unsafe(nil), level: T.unsafe(nil), progname: T.unsafe(nil), formatter: T.unsafe(nil), datetime_format: T.unsafe(nil), binmode: T.unsafe(nil), shift_period_suffix: T.unsafe(nil), reraise_write_errors: T.unsafe(nil)); end
# Writes the given +msg+ to the log with no formatting;
# returns the number of characters written,
@ -415,7 +420,7 @@ class Logger
#
# My message.
#
# source://logger//logger.rb#684
# source://logger//lib/logger.rb#689
def <<(msg); end
# Creates a log entry, which may or may not be written to the log,
@ -445,7 +450,7 @@ class Logger
# - #fatal.
# - #unknown.
#
# source://logger//logger.rb#651
# source://logger//lib/logger.rb#656
def add(severity, message = T.unsafe(nil), progname = T.unsafe(nil)); end
# Closes the logger; returns +nil+:
@ -456,12 +461,12 @@ class Logger
#
# Related: Logger#reopen.
#
# source://logger//logger.rb#731
# source://logger//lib/logger.rb#736
def close; end
# Returns the date-time format; see #datetime_format=.
#
# source://logger//logger.rb#438
# source://logger//lib/logger.rb#438
def datetime_format; end
# Sets the date-time format.
@ -469,21 +474,21 @@ class Logger
# Argument +datetime_format+ should be either of these:
#
# - A string suitable for use as a format for method
# {Time#strftime}[rdoc-ref:Time#strftime].
# {Time#strftime}[https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime].
# - +nil+: the logger uses <tt>'%Y-%m-%dT%H:%M:%S.%6N'</tt>.
#
# source://logger//logger.rb#432
# source://logger//lib/logger.rb#432
def datetime_format=(datetime_format); end
# Equivalent to calling #add with severity <tt>Logger::DEBUG</tt>.
#
# source://logger//logger.rb#690
# source://logger//lib/logger.rb#695
def debug(progname = T.unsafe(nil), &block); end
# Sets the log level to Logger::DEBUG.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
# source://logger//logger.rb#487
# source://logger//lib/logger.rb#487
def debug!; end
# Returns +true+ if the log level allows entries with severity
@ -492,18 +497,18 @@ class Logger
#
# @return [Boolean]
#
# source://logger//logger.rb#482
# source://logger//lib/logger.rb#482
def debug?; end
# Equivalent to calling #add with severity <tt>Logger::ERROR</tt>.
#
# source://logger//logger.rb#708
# source://logger//lib/logger.rb#713
def error(progname = T.unsafe(nil), &block); end
# Sets the log level to Logger::ERROR.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
# source://logger//logger.rb#520
# source://logger//lib/logger.rb#520
def error!; end
# Returns +true+ if the log level allows entries with severity
@ -512,18 +517,18 @@ class Logger
#
# @return [Boolean]
#
# source://logger//logger.rb#515
# source://logger//lib/logger.rb#515
def error?; end
# Equivalent to calling #add with severity <tt>Logger::FATAL</tt>.
#
# source://logger//logger.rb#714
# source://logger//lib/logger.rb#719
def fatal(progname = T.unsafe(nil), &block); end
# Sets the log level to Logger::FATAL.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
# source://logger//logger.rb#531
# source://logger//lib/logger.rb#531
def fatal!; end
# Returns +true+ if the log level allows entries with severity
@ -532,7 +537,7 @@ class Logger
#
# @return [Boolean]
#
# source://logger//logger.rb#526
# source://logger//lib/logger.rb#526
def fatal?; end
# Sets or retrieves the logger entry formatter proc.
@ -550,7 +555,7 @@ class Logger
# The proc should return a string containing the formatted entry.
#
# This custom formatter uses
# {String#dump}[rdoc-ref:String#dump]
# {String#dump}[https://docs.ruby-lang.org/en/master/String.html#method-i-dump]
# to escape the message string:
#
# logger = Logger.new($stdout, progname: 'mung')
@ -566,7 +571,7 @@ class Logger
# I, [2022-05-13T13:16:29.637488 #8492] INFO -- mung: "hello \n ''"
# I, [2022-05-13T13:16:29.637610 #8492] INFO -- mung: "\f\x00\xFF\\\""
#
# source://logger//logger.rb#473
# source://logger//lib/logger.rb#473
def formatter; end
# Sets or retrieves the logger entry formatter proc.
@ -584,7 +589,7 @@ class Logger
# The proc should return a string containing the formatted entry.
#
# This custom formatter uses
# {String#dump}[rdoc-ref:String#dump]
# {String#dump}[https://docs.ruby-lang.org/en/master/String.html#method-i-dump]
# to escape the message string:
#
# logger = Logger.new($stdout, progname: 'mung')
@ -600,18 +605,18 @@ class Logger
# I, [2022-05-13T13:16:29.637488 #8492] INFO -- mung: "hello \n ''"
# I, [2022-05-13T13:16:29.637610 #8492] INFO -- mung: "\f\x00\xFF\\\""
#
# source://logger//logger.rb#473
# source://logger//lib/logger.rb#473
def formatter=(_arg0); end
# Equivalent to calling #add with severity <tt>Logger::INFO</tt>.
#
# source://logger//logger.rb#696
# source://logger//lib/logger.rb#701
def info(progname = T.unsafe(nil), &block); end
# Sets the log level to Logger::INFO.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
# source://logger//logger.rb#498
# source://logger//lib/logger.rb#498
def info!; end
# Returns +true+ if the log level allows entries with severity
@ -620,12 +625,12 @@ class Logger
#
# @return [Boolean]
#
# source://logger//logger.rb#493
# source://logger//lib/logger.rb#493
def info?; end
# Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
#
# source://logger//logger.rb#383
# source://logger//lib/logger.rb#383
def level; end
# Sets the log level; returns +severity+.
@ -640,7 +645,7 @@ class Logger
#
# Logger#sev_threshold= is an alias for Logger#level=.
#
# source://logger//logger.rb#399
# source://logger//lib/logger.rb#399
def level=(severity); end
# Creates a log entry, which may or may not be written to the log,
@ -670,17 +675,17 @@ class Logger
# - #fatal.
# - #unknown.
#
# source://logger//logger.rb#651
# source://logger//lib/logger.rb#656
def log(severity, message = T.unsafe(nil), progname = T.unsafe(nil)); end
# Program name to include in log messages.
#
# source://logger//logger.rb#422
# source://logger//lib/logger.rb#422
def progname; end
# Program name to include in log messages.
#
# source://logger//logger.rb#422
# source://logger//lib/logger.rb#422
def progname=(_arg0); end
# Sets the logger's output stream:
@ -706,12 +711,12 @@ class Logger
# # "E, [2022-05-12T14:21:27.596726 #22428] ERROR -- : one\n",
# # "E, [2022-05-12T14:23:05.847241 #22428] ERROR -- : three\n"]
#
# source://logger//logger.rb#619
# source://logger//lib/logger.rb#624
def reopen(logdev = T.unsafe(nil)); end
# Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
#
# source://logger//logger.rb#383
# source://logger//lib/logger.rb#383
def sev_threshold; end
# Sets the log level; returns +severity+.
@ -726,23 +731,23 @@ class Logger
#
# Logger#sev_threshold= is an alias for Logger#level=.
#
# source://logger//logger.rb#399
# source://logger//lib/logger.rb#399
def sev_threshold=(severity); end
# Equivalent to calling #add with severity <tt>Logger::UNKNOWN</tt>.
#
# source://logger//logger.rb#720
# source://logger//lib/logger.rb#725
def unknown(progname = T.unsafe(nil), &block); end
# Equivalent to calling #add with severity <tt>Logger::WARN</tt>.
#
# source://logger//logger.rb#702
# source://logger//lib/logger.rb#707
def warn(progname = T.unsafe(nil), &block); end
# Sets the log level to Logger::WARN.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
# source://logger//logger.rb#509
# source://logger//lib/logger.rb#509
def warn!; end
# Returns +true+ if the log level allows entries with severity
@ -751,7 +756,7 @@ class Logger
#
# @return [Boolean]
#
# source://logger//logger.rb#504
# source://logger//lib/logger.rb#504
def warn?; end
# Adjust the log level during the block execution for the current Fiber only
@ -760,144 +765,156 @@ class Logger
# logger.debug { "Hello" }
# end
#
# source://logger//logger.rb#408
# source://logger//lib/logger.rb#408
def with_level(severity); end
private
# source://logger//logger.rb#744
# source://logger//lib/logger.rb#754
def format_message(severity, datetime, progname, msg); end
# source://logger//logger.rb#740
# source://logger//lib/logger.rb#745
def format_severity(severity); end
# Guarantee the existence of this ivar even when subclasses don't call the superclass constructor.
#
# source://logger//lib/logger.rb#750
def level_override; end
end
# Default formatter for log messages.
#
# source://logger//lib/logger/formatter.rb#5
class Logger::Formatter
# @return [Formatter] a new instance of Formatter
#
# source://logger//logger/formatter.rb#11
# source://logger//lib/logger/formatter.rb#11
def initialize; end
# source://logger//logger/formatter.rb#15
# source://logger//lib/logger/formatter.rb#15
def call(severity, time, progname, msg); end
# Returns the value of attribute datetime_format.
#
# source://logger//logger/formatter.rb#9
# source://logger//lib/logger/formatter.rb#9
def datetime_format; end
# Sets the attribute datetime_format
#
# @param value the value to set the attribute datetime_format to.
#
# source://logger//logger/formatter.rb#9
# source://logger//lib/logger/formatter.rb#9
def datetime_format=(_arg0); end
private
# source://logger//logger/formatter.rb#21
# source://logger//lib/logger/formatter.rb#21
def format_datetime(time); end
# source://logger//logger/formatter.rb#25
# source://logger//lib/logger/formatter.rb#25
def msg2str(msg); end
end
# source://logger//logger/formatter.rb#7
# source://logger//lib/logger/formatter.rb#7
Logger::Formatter::DatetimeFormat = T.let(T.unsafe(nil), String)
# source://logger//logger/formatter.rb#6
# source://logger//lib/logger/formatter.rb#6
Logger::Formatter::Format = T.let(T.unsafe(nil), String)
# Device used for logging messages.
#
# source://logger//lib/logger/log_device.rb#7
class Logger::LogDevice
include ::Logger::Period
include ::MonitorMixin
# @return [LogDevice] a new instance of LogDevice
#
# source://logger//logger/log_device.rb#14
def initialize(log = T.unsafe(nil), shift_age: T.unsafe(nil), shift_size: T.unsafe(nil), shift_period_suffix: T.unsafe(nil), binmode: T.unsafe(nil)); end
# source://logger//lib/logger/log_device.rb#14
def initialize(log = T.unsafe(nil), shift_age: T.unsafe(nil), shift_size: T.unsafe(nil), shift_period_suffix: T.unsafe(nil), binmode: T.unsafe(nil), reraise_write_errors: T.unsafe(nil)); end
# source://logger//logger/log_device.rb#52
# source://logger//lib/logger/log_device.rb#59
def close; end
# Returns the value of attribute dev.
#
# source://logger//logger/log_device.rb#10
# source://logger//lib/logger/log_device.rb#10
def dev; end
# Returns the value of attribute filename.
#
# source://logger//logger/log_device.rb#11
# source://logger//lib/logger/log_device.rb#11
def filename; end
# source://logger//logger/log_device.rb#62
# source://logger//lib/logger/log_device.rb#69
def reopen(log = T.unsafe(nil)); end
# source://logger//logger/log_device.rb#31
# source://logger//lib/logger/log_device.rb#32
def write(message); end
private
# source://logger//logger/log_device.rb#119
# source://logger//lib/logger/log_device.rb#126
def add_log_header(file); end
# source://logger//logger/log_device.rb#125
# source://logger//lib/logger/log_device.rb#132
def check_shift_log; end
# source://logger//logger/log_device.rb#103
# source://logger//lib/logger/log_device.rb#110
def create_logfile(filename); end
# source://logger//logger/log_device.rb#145
# source://logger//lib/logger/log_device.rb#152
def lock_shift_log; end
# source://logger//logger/log_device.rb#95
# source://logger//lib/logger/log_device.rb#102
def open_logfile(filename); end
# source://logger//logger/log_device.rb#79
# source://logger//lib/logger/log_device.rb#86
def set_dev(log); end
# source://logger//logger/log_device.rb#176
# source://logger//lib/logger/log_device.rb#183
def shift_log_age; end
# source://logger//logger/log_device.rb#188
# source://logger//lib/logger/log_device.rb#195
def shift_log_period(period_end); end
end
# source://logger//lib/logger/period.rb#4
module Logger::Period
private
# source://logger//logger/period.rb#9
# source://logger//lib/logger/period.rb#9
def next_rotate_time(now, shift_age); end
# source://logger//logger/period.rb#31
# source://logger//lib/logger/period.rb#31
def previous_period_end(now, shift_age); end
class << self
# source://logger//logger/period.rb#9
# source://logger//lib/logger/period.rb#9
def next_rotate_time(now, shift_age); end
# source://logger//logger/period.rb#31
# source://logger//lib/logger/period.rb#31
def previous_period_end(now, shift_age); end
end
end
# source://logger//logger/period.rb#7
# source://logger//lib/logger/period.rb#7
Logger::Period::SiD = T.let(T.unsafe(nil), Integer)
# \Severity label for logging (max 5 chars).
#
# source://logger//logger.rb#738
# source://logger//lib/logger.rb#743
Logger::SEV_LABEL = T.let(T.unsafe(nil), Array)
# Logging severity.
#
# source://logger//lib/logger/severity.rb#5
module Logger::Severity
class << self
# source://logger//logger/severity.rb#29
# source://logger//lib/logger/severity.rb#29
def coerce(severity); end
end
end
# source://logger//logger/severity.rb#19
# source://logger//lib/logger/severity.rb#19
Logger::Severity::LEVELS = T.let(T.unsafe(nil), Hash)