模块 Digest::Instance

此模块为摘要实现对象提供实例方法，用于计算消息摘要值。

公共实例方法

digest_obj << string → digest_obj

使用给定的 string 更新摘要并返回自身。

update() 方法和左移运算符被每个实现子类覆盖。（两者应该互为别名）

别名：update

digest_obj == another_digest_obj → boolean 点击切换源代码

digest_obj == string → boolean

如果给定一个字符串，则检查它是否等于摘要对象的十六进制编码哈希值。如果给定另一个摘要实例，则检查它们是否具有相同的哈希值。否则返回 false。

static VALUE
rb_digest_instance_equal(VALUE self, VALUE other)
{
    VALUE str1, str2;

    if (rb_obj_is_kind_of(other, rb_mDigest_Instance) == Qtrue) {
        str1 = rb_digest_instance_digest(0, 0, self);
        str2 = rb_digest_instance_digest(0, 0, other);
    } else {
        str1 = rb_digest_instance_to_s(self);
        str2 = rb_check_string_type(other);
        if (NIL_P(str2)) return Qfalse;
    }

    /* never blindly assume that subclass methods return strings */
    StringValue(str1);
    StringValue(str2);

    if (RSTRING_LEN(str1) == RSTRING_LEN(str2) &&
        rb_str_cmp(str1, str2) == 0) {
        return Qtrue;
    }
    return Qfalse;
}

base64digest(str = nil) 点击切换源代码

如果没有给出，则以 base64 编码形式返回摘要的最终哈希值，保持摘要的状态。

如果给定一个 string，则以 base64 编码形式返回给定 string 的哈希值，在过程之前和之后将摘要重置为初始状态。

在这两种情况下，返回值都用 ‘=’ 适当填充，并且不包含换行符。

# File digest/lib/digest.rb, line 82
def base64digest(str = nil)
  [str ? digest(str) : digest].pack('m0')
end

base64digest!() 点击切换源代码

返回最终哈希值并将摘要重置为初始状态。

# File digest/lib/digest.rb, line 88
def base64digest!
  [digest!].pack('m0')
end

block_length → integer 点击切换源代码

返回摘要的块长度。

此方法被每个实现子类覆盖。

static VALUE
rb_digest_instance_block_length(VALUE self)
{
    rb_digest_instance_method_unimpl(self, "block_length");

    UNREACHABLE;
}

bubblebabble → hash_string 点击切换源代码

以 Bubblebabble 编码形式返回最终哈希值。

static VALUE
rb_digest_instance_bubblebabble(VALUE self)
{
    return bubblebabble_str_new(rb_funcall(self, id_digest, 0));
}

digest → string 点击切换源代码

digest(string) → string

如果未提供参数，则返回摘要的哈希值，并保持摘要的状态。

如果提供了string，则返回给定string的哈希值，并在处理前后将摘要重置为初始状态。

static VALUE
rb_digest_instance_digest(int argc, VALUE *argv, VALUE self)
{
    VALUE str, value;

    if (rb_scan_args(argc, argv, "01", &str) > 0) {
        rb_funcall(self, id_reset, 0);
        rb_funcall(self, id_update, 1, str);
        value = rb_funcall(self, id_finish, 0);
        rb_funcall(self, id_reset, 0);
    } else {
        value = rb_funcall(rb_obj_clone(self), id_finish, 0);
    }

    return value;
}

digest! → string 点击切换源代码

返回最终哈希值并将摘要重置为初始状态。

static VALUE
rb_digest_instance_digest_bang(VALUE self)
{
    VALUE value = rb_funcall(self, id_finish, 0);
    rb_funcall(self, id_reset, 0);

    return value;
}

digest_length → integer 点击切换源代码

返回摘要的哈希值的长度。

此方法应由每个实现子类覆盖。如果没有，则返回 digest_obj.digest().length()。

static VALUE
rb_digest_instance_digest_length(VALUE self)
{
    /* subclasses really should redefine this method */
    VALUE digest = rb_digest_instance_digest(0, 0, self);

    /* never blindly assume that #digest() returns a string */
    StringValue(digest);
    return LONG2NUM(RSTRING_LEN(digest));
}

file(name) 点击切换源代码

使用给定文件name的内容更新摘要，并返回自身。

# File digest/lib/digest.rb, line 63
def file(name)
  File.open(name, "rb") {|f|
    buf = ""
    while f.read(16384, buf)
      update buf
    end
  }
  self
end

hexdigest → string 点击切换源代码

hexdigest(string) → string

如果未提供参数，则返回摘要的哈希值，以十六进制编码形式，并保持摘要的状态。

如果提供了string，则返回给定string的哈希值，以十六进制编码形式，并在处理前后将摘要重置为初始状态。

static VALUE
rb_digest_instance_hexdigest(int argc, VALUE *argv, VALUE self)
{
    VALUE str, value;

    if (rb_scan_args(argc, argv, "01", &str) > 0) {
        rb_funcall(self, id_reset, 0);
        rb_funcall(self, id_update, 1, str);
        value = rb_funcall(self, id_finish, 0);
        rb_funcall(self, id_reset, 0);
    } else {
        value = rb_funcall(rb_obj_clone(self), id_finish, 0);
    }

    return hexencode_str_new(value);
}

hexdigest! → string 点击切换源代码

返回十六进制编码形式的哈希值，并将摘要重置为初始状态。

static VALUE
rb_digest_instance_hexdigest_bang(VALUE self)
{
    VALUE value = rb_funcall(self, id_finish, 0);
    rb_funcall(self, id_reset, 0);

    return hexencode_str_new(value);
}

inspect → string 点击切换源代码

创建摘要对象的打印版本。

static VALUE
rb_digest_instance_inspect(VALUE self)
{
    VALUE str;
    size_t digest_len = 32;     /* about this size at least */
    const char *cname;

    cname = rb_obj_classname(self);

    /* #<Digest::ClassName: xxxxx...xxxx> */
    str = rb_str_buf_new(2 + strlen(cname) + 2 + digest_len * 2 + 1);
    rb_str_buf_cat2(str, "#<");
    rb_str_buf_cat2(str, cname);
    rb_str_buf_cat2(str, ": ");
    rb_str_buf_append(str, rb_digest_instance_hexdigest(0, 0, self));
    rb_str_buf_cat2(str, ">");
    return str;
}

length → integer 点击切换源代码

返回 digest_obj.digest_length()。

static VALUE
rb_digest_instance_length(VALUE self)
{
    return rb_funcall(self, id_digest_length, 0);
}

也称为：size

new → another_digest_obj 点击切换源代码

返回摘要对象的新的初始化副本。等效于 digest_obj.clone().reset()。

static VALUE
rb_digest_instance_new(VALUE self)
{
    VALUE clone = rb_obj_clone(self);
    rb_funcall(clone, id_reset, 0);
    return clone;
}

reset → digest_obj 点击切换源代码

将摘要重置为初始状态，并返回自身。

此方法被每个实现子类覆盖。

static VALUE
rb_digest_instance_reset(VALUE self)
{
    rb_digest_instance_method_unimpl(self, "reset");

    UNREACHABLE;
}

size → integer

返回 digest_obj.digest_length()。

别名：length

to_s → string 点击切换源代码

返回 digest_obj.hexdigest()。

static VALUE
rb_digest_instance_to_s(VALUE self)
{
    return rb_funcall(self, id_hexdigest, 0);
}

update(string) → digest_obj 点击切换源代码

使用给定的 string 更新摘要并返回自身。

update() 方法和左移运算符被每个实现子类覆盖。（两者应该互为别名）

static VALUE
rb_digest_instance_update(VALUE self, VALUE str)
{
    rb_digest_instance_method_unimpl(self, "update");

    UNREACHABLE;
}

别名：<<

私有实例方法

instance_eval { finish } → digest_obj 点击切换源代码

完成摘要并返回生成的哈希值。

此方法被每个实现子类覆盖，并且通常被设为私有，因为某些子类可能留下内部数据未初始化。不要从外部调用此方法。请使用 digest!()，它可以确保出于安全原因重置内部数据。

static VALUE
rb_digest_instance_finish(VALUE self)
{
    rb_digest_instance_method_unimpl(self, "finish");

    UNREACHABLE;
}