类 Digest::Base

此抽象类为用 C 语言编写的消息摘要实现类提供通用接口。

用 C 语言编写 `Digest` 子类¶ ↑

Digest::Base 为用 C 语言编写的消息摘要类提供通用接口。这些类必须提供一个类型为 rb_digest_metadata_t 的结构体。

typedef int (*rb_digest_hash_init_func_t)(void *);
typedef void (*rb_digest_hash_update_func_t)(void *, unsigned char *, size_t);
typedef int (*rb_digest_hash_finish_func_t)(void *, unsigned char *);

typedef struct {
  int api_version;
  size_t digest_len;
  size_t block_len;
  size_t ctx_size;
  rb_digest_hash_init_func_t init_func;
  rb_digest_hash_update_func_t update_func;
  rb_digest_hash_finish_func_t finish_func;
} rb_digest_metadata_t;

此结构体必须设置为名为 metadata 的实例变量（名称前面没有 +@+）。例如

 static const rb_digest_metadata_t sha1 = {
    RUBY_DIGEST_API_VERSION,
    SHA1_DIGEST_LENGTH,
    SHA1_BLOCK_LENGTH,
    sizeof(SHA1_CTX),
    (rb_digest_hash_init_func_t)SHA1_Init,
    (rb_digest_hash_update_func_t)SHA1_Update,
    (rb_digest_hash_finish_func_t)SHA1_Finish,
};

rb_ivar_set(cDigest_SHA1, rb_intern("metadata"),
            Data_Wrap_Struct(0, 0, 0, (void *)&sha1));

公共实例方法

digest_base << string → digest_base

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

别名：update

block_length → Integer 点击切换源代码

返回摘要的块长度（以字节为单位）。

static VALUE
rb_digest_base_block_length(VALUE self)
{
    rb_digest_metadata_t *algo;

    algo = get_digest_obj_metadata(self);

    return SIZET2NUM(algo->block_len);
}

digest_length → Integer 点击切换源代码

返回哈希值的长度（以字节为单位）。

static VALUE
rb_digest_base_digest_length(VALUE self)
{
    rb_digest_metadata_t *algo;

    algo = get_digest_obj_metadata(self);

    return SIZET2NUM(algo->digest_len);
}

reset → digest_base 点击切换源代码

将摘要重置为其初始状态并返回 self。

static VALUE
rb_digest_base_reset(VALUE self)
{
    rb_digest_metadata_t *algo;
    void *pctx;

    algo = get_digest_obj_metadata(self);

    TypedData_Get_Struct(self, void, &digest_type, pctx);

    algo_init(algo, pctx);

    return self;
}

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

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

static VALUE
rb_digest_base_update(VALUE self, VALUE str)
{
    rb_digest_metadata_t *algo;
    void *pctx;

    algo = get_digest_obj_metadata(self);

    TypedData_Get_Struct(self, void, &digest_type, pctx);

    StringValue(str);
    algo->update_func(pctx, (unsigned char *)RSTRING_PTR(str), RSTRING_LEN(str));
    RB_GC_GUARD(str);

    return self;
}

也称为：<<

类 Digest::Base

用 C 语言编写 Digest 子类¶ ↑

用 C 语言编写 `Digest` 子类¶ ↑