class PG::Coder
This is the base class for all type cast encoder and decoder classes.
It can be used for implicit type casts by a PG::TypeMap
or to convert single values to/from their string representation by encode and decode.
Ruby nil
values are not handled by encoders, but are always transmitted as SQL NULL
value. Vice versa SQL NULL
values are not handled by decoders, but are always returned as a nil
value.
Constants
- FORMAT_ERROR_MASK
- FORMAT_ERROR_TO_PARTIAL
- FORMAT_ERROR_TO_RAISE
- FORMAT_ERROR_TO_STRING
- TIMESTAMP_APP_LOCAL
- TIMESTAMP_APP_UTC
- TIMESTAMP_DB_LOCAL
- TIMESTAMP_DB_UTC
Attributes
Name of the coder or the corresponding data type.
This accessor is only used in PG::Coder#inspect
.
Public Class Methods
Create a new coder object based on the attribute Hash.
# File lib/pg/coder.rb, line 16 def initialize(params={}) params.each do |key, val| send("#{key}=", val) end end
Public Instance Methods
# File lib/pg/coder.rb, line 36 def ==(v) self.class == v.class && to_h == v.to_h end
# File lib/pg/coder.rb, line 22 def dup self.class.new(to_h) end
Get current bitwise OR-ed coder flags.
static VALUE pg_coder_flags_get(VALUE self) { t_pg_coder *this = DATA_PTR(self); return INT2NUM(this->flags); }
Set coder specific bitwise OR-ed flags. See the particular en- or decoder description for available flags.
The default is 0
.
static VALUE pg_coder_flags_set(VALUE self, VALUE flags) { t_pg_coder *this = DATA_PTR(self); this->flags = NUM2INT(flags); return flags; }
The format code that is sent alongside with an encoded query parameter value.
static VALUE pg_coder_format_get(VALUE self) { t_pg_coder *this = DATA_PTR(self); return INT2NUM(this->format); }
Specifies the format code that is sent alongside with an encoded query parameter value.
The default is 0
.
static VALUE pg_coder_format_set(VALUE self, VALUE format) { t_pg_coder *this = DATA_PTR(self); this->format = NUM2INT(format); return format; }
# File lib/pg/coder.rb, line 48 def inspect str = self.to_s oid_str = " oid=#{oid}" unless oid==0 format_str = " format=#{format}" unless format==0 name_str = " #{name.inspect}" if name str[-1,0] = "#{name_str} #{oid_str}#{format_str}" str end
# File lib/pg/coder.rb, line 57 def inspect_short str = case format when 0 then "T" when 1 then "B" else format.to_s end str += "E" if respond_to?(:encode) str += "D" if respond_to?(:decode) "#{name || self.class.name}:#{str}" end
# File lib/pg/coder.rb, line 40 def marshal_dump Marshal.dump(to_h) end
# File lib/pg/coder.rb, line 44 def marshal_load(str) initialize Marshal.load(str) end
The type OID that is sent alongside with an encoded query parameter value.
static VALUE pg_coder_oid_get(VALUE self) { t_pg_coder *this = DATA_PTR(self); return UINT2NUM(this->oid); }
Specifies the type OID that is sent alongside with an encoded query parameter value.
The default is 0
.
static VALUE pg_coder_oid_set(VALUE self, VALUE oid) { t_pg_coder *this = DATA_PTR(self); this->oid = NUM2UINT(oid); return oid; }
Returns coder attributes as Hash.
# File lib/pg/coder.rb, line 27 def to_h { oid: oid, format: format, flags: flags, name: name, } end