yo_kv/

strings.rs

//! The string type and its commands.
//!
//! The commands are an `impl` block on [`Keyspace`] rather than methods on some
//! per type object, because a key belongs to the database and not to a type.
//! Everything in this file is about strings; everything that is about the
//! database whatever it holds is in [`keyspace`](crate::keyspace).
//!
//! One method per Redis command, taking and returning ordinary Rust values.
//! There is no command enum here and no dispatch: this is the layer the wire
//! calls into and the layer the embedded API calls into, and Y23 says those two
//! have to be the same code rather than two implementations of the same idea.
//! Anything that is about parsing arguments or writing a reply lives above.
//!
//! Errors carry Redis's own message text, because it ends up on the wire
//! verbatim, and a [`Code`] alongside it, because the embedded caller should be
//! matching on a value rather than on a string (P5).

use crate::cond::Compare;
use crate::counter::{self, Counted, IncrEx, IncrExpire, Num};
use crate::keyspace::{Keyspace, wrong_type};
use crate::lcs;
use crate::value::{self, Encoding, Kind, Str};
use std::borrow::Cow;
use yo_common::num::parse_f64;
use yo_common::{Code, Error, Result};
use yo_index::RawMap;

/// What Redis says when a value should have been a number and was not.
const NOT_AN_INT: &str = "value is not an integer or out of range";
/// What Redis says when a value should have been a float and was not.
const NOT_A_FLOAT: &str = "value is not a valid float";
/// What Redis says when the result of a counter would leave the range.
const WOULD_OVERFLOW: &str = "increment or decrement would overflow";
/// What Redis says when a write would make a string too long.
const TOO_LONG: &str = "string exceeds maximum allowed size (proto-max-bulk-len)";
/// What we say when a key is longer than this band holds.
const KEY_TOO_LONG: &str = "key exceeds maximum allowed size";
/// What Redis says when an offset is negative or past the end of the world.
const BAD_OFFSET: &str = "offset is out of range";

/// The longest key this band stores.
///
/// Redis's limit is 512 MiB for a key as well as for a value. A key that long is
/// not a key, it is a value in the wrong place, and holding the ceiling down
/// here is what lets [`STRING_MAX`] be a constant rather than a function of the
/// key in hand.
pub const KEY_MAX: usize = 64 * 1024;

/// The largest string this band stores.
///
/// Redis's limit is 512 MiB. Ours is a segment, because a string lives in the
/// arena and the arena hands out at most one segment's worth in one piece. The
/// band above this is the log region (`06` section 2) and lands with tiering in
/// M5, at which point this constant goes up to Redis's. It is a divergence and
/// it is listed as one rather than left for somebody to discover.
pub const STRING_MAX: usize = RawMap::max_record() - RawMap::header_len() - KEY_MAX - 16;

/// Whether a `SET` should go ahead given what is already there.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum Exists {
    /// Store whatever is there. Plain `SET`.
    #[default]
    Always,
    /// Only if the key is absent. `SET NX`, and `SETNX`.
    IfMissing,
    /// Only if the key is present. `SET XX`.
    IfPresent,
}

/// What a write should do with the key's deadline.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum Expire {
    /// Leave the key with no deadline. Plain `SET`, and `GETEX PERSIST`.
    #[default]
    Clear,
    /// Leave whatever deadline was there. `SET KEEPTTL`, and plain `GETEX`.
    Keep,
    /// Expire at this absolute unix millisecond. `EX`, `PX`, `EXAT`, `PXAT`.
    At(u64),
}

/// Everything `SET` can be asked to do beyond storing the value.
#[derive(Debug, Clone, Copy, Default)]
pub struct SetOptions<'a> {
    /// `NX` or `XX`.
    pub exists: Exists,
    /// `EX`, `PX`, `EXAT`, `PXAT` or `KEEPTTL`.
    pub expire: Expire,
    /// `IFEQ`, `IFNE`, `IFDEQ` or `IFDNE`.
    ///
    /// Redis 8.4's compare and set. A missing key never compares equal, so
    /// `IFEQ` on a key that is not there does not store, and `IFNE` on one
    /// does.
    pub compare: Option<Compare<'a>>,
    /// `GET`: hand back what was there, whether or not the write happened.
    pub get: bool,
}

impl<'a> SetOptions<'a> {
    /// No options at all, which is plain `SET`.
    pub const PLAIN: SetOptions<'static> = SetOptions {
        exists: Exists::Always,
        expire: Expire::Clear,
        compare: None,
        get: false,
    };

    /// This, but only if the key is missing.
    #[must_use]
    pub const fn if_missing(mut self) -> SetOptions<'a> {
        self.exists = Exists::IfMissing;
        self
    }

    /// This, but only if the key is present.
    #[must_use]
    pub const fn if_present(mut self) -> SetOptions<'a> {
        self.exists = Exists::IfPresent;
        self
    }

    /// This, with a deadline.
    #[must_use]
    pub const fn expiring(mut self, e: Expire) -> SetOptions<'a> {
        self.expire = e;
        self
    }

    /// This, but only if the current value is exactly `bytes`. `IFEQ`.
    #[must_use]
    pub const fn if_equal(mut self, bytes: &'a [u8]) -> SetOptions<'a> {
        self.compare = Some(Compare::Equal(bytes));
        self
    }

    /// This, but only if the current value is not exactly `bytes`. `IFNE`.
    #[must_use]
    pub const fn if_not_equal(mut self, bytes: &'a [u8]) -> SetOptions<'a> {
        self.compare = Some(Compare::NotEqual(bytes));
        self
    }

    /// This, but only against a value whose digest is `d`. `IFDEQ`.
    #[must_use]
    pub const fn if_digest(mut self, d: u64) -> SetOptions<'a> {
        self.compare = Some(Compare::DigestEqual(d));
        self
    }

    /// This, but only against a value whose digest is not `d`. `IFDNE`.
    #[must_use]
    pub const fn if_not_digest(mut self, d: u64) -> SetOptions<'a> {
        self.compare = Some(Compare::DigestNotEqual(d));
        self
    }

    /// This, returning the previous value.
    #[must_use]
    pub const fn returning(mut self) -> SetOptions<'a> {
        self.get = true;
        self
    }
}

/// What a `SET` did.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct SetOutcome {
    /// Whether the value was written. `NX`, `XX` and `IFEQ` can all say no.
    pub stored: bool,
    /// The previous value, when `GET` was asked for and there was one.
    ///
    /// Owned, because the record it lived in has been written over by the time
    /// this is handed back, and only ever filled in by [`Keyspace::set`]. A
    /// caller that does not want the copy calls [`Keyspace::set_with`] and gets
    /// the old value where it still lives, which is what the wire does.
    pub previous: Option<Vec<u8>>,
}

/// The string commands.
///
/// These hang off the database rather than off a per type object, because a
/// key belongs to the database: `GET` against a set has to be able to see that
/// it is a set.
impl Keyspace {
    // ---------------------------------------------------------------- reading

    /// `GET key`.
    ///
    /// One probe of the map for the whole command. It used to be three, because
    /// the reap looked the key up to see whether it was dead, the type check
    /// looked it up to see whether it was a string, and the read looked it up
    /// again to read it, and all three walked a bucket for the same record.
    /// `Keyspace::live_rec` hands back where that record is and the rest is
    /// two arena reads at a known address.
    pub fn get(&mut self, key: &[u8]) -> Result<Option<Str<'_>>> {
        let Some(addr) = self.live_rec(key) else {
            return Ok(None);
        };
        let rec = self.map.value_at(addr);
        if value::kind(rec) != Kind::String {
            return Err(wrong_type());
        }
        // One more bit of the byte the kind came out of, and on a database with
        // no file behind it no record ever has it set. See
        // [`Keyspace::warmed`].
        if value::cold(rec).is_some() {
            return self.warmed(key);
        }
        Ok(Some(value::read(self.map.value_at(addr))))
    }

    /// `MGET key [key ...]`.
    ///
    /// Every dead key is reaped first and the whole answer is then read from a
    /// store nobody is going to mutate, which is what lets all of the returned
    /// values borrow from it at once instead of being copied out one at a time.
    pub fn mget<'a>(&'a mut self, keys: &[&[u8]]) -> Vec<Option<Str<'a>>> {
        for k in keys {
            // A demoted value is brought back into memory here rather than
            // served from the buffer, because this form hands back every value
            // at once and there is one buffer. The wire does not come through
            // here, it calls [`Keyspace::mget_one`] per key, and that one asks
            // the doorkeeper properly. An error is dropped: this returns a
            // `Vec` with no room in it to say that one key would not read back,
            // and the key then reads as nil, which is what a key holding the
            // wrong type does two lines below.
            let _ = self.thaw(k);
            // `live_rec` rather than `reap`, which does the same reap and also
            // stamps the eviction clock. The reading pass below cannot, because
            // it holds a shared borrow of the whole database so that every value
            // it returns can borrow from it at once. The wire does not come
            // through here at all, it walks the keys itself and calls
            // [`Keyspace::mget_one`], so without this the same command would
            // stamp from one entry point and not from the other.
            self.live_rec(k);
        }
        let me: &Keyspace = self;
        keys.iter().map(|k| me.peek(k)).collect()
    }

    /// One key of an `MGET`, which is nil rather than an error for a key that
    /// holds another type.
    ///
    /// [`Keyspace::mget`] collects the whole answer into a `Vec` for a caller
    /// that wants it in one piece. The wire wants the keys one at a time and in
    /// order, and a `Vec` there would be an allocation per call on a thread that
    /// must not allocate, so the dispatcher walks the keys itself and calls this
    /// for each. It is not `get`, because `MGET` does not answer `WRONGTYPE`:
    /// Redis gives nil for the odd key out rather than failing the ninety nine
    /// good ones alongside it.
    pub fn mget_one(&mut self, key: &[u8]) -> Option<Str<'_>> {
        let addr = self.live_rec(key)?;
        let rec = self.map.value_at(addr);
        if value::kind(rec) != Kind::String {
            return None;
        }
        if value::cold(rec).is_some() {
            // A key whose value will not read back is nil here rather than an
            // error, the same as a key holding a set is. `MGET` has no way to
            // report one bad key out of a hundred and Redis does not try.
            return self.warmed(key).ok().flatten();
        }
        Some(value::read(self.map.value_at(addr)))
    }

    /// `STRLEN key`, which is zero for a key that is not there.
    ///
    /// Answered out of the record even when the value is on the file, because a
    /// demoted record carries the length next to the address. Going to the
    /// device for a number that is already in memory would be a device read
    /// spent on nothing, and it would be one that a client could use to pull a
    /// whole database back into memory a key at a time.
    pub fn strlen(&mut self, key: &[u8]) -> Result<usize> {
        let Some(addr) = self.live_rec(key) else {
            return Ok(0);
        };
        let rec = self.map.value_at(addr);
        if value::kind(rec) != Kind::String {
            return Err(wrong_type());
        }
        if let Some(c) = value::cold(rec) {
            return Ok(c.len as usize);
        }
        Ok(value::read(rec).len())
    }

    /// `EXISTS key`, for one key.
    ///
    /// Asking whether a key is there does not count as using it, which is
    /// Redis's rule and not a nicety. A health check that runs `EXISTS` over a
    /// list of keys every second would otherwise be enough on its own to make
    /// all of them look like the hottest keys in the database.
    pub fn exists(&mut self, key: &[u8]) -> bool {
        self.live_rec_untouched(key).is_some()
    }

    /// How a string is stored, which is `OBJECT ENCODING` for a string key.
    ///
    /// `None` for a key that is not there and for a key holding another type,
    /// because the two encoding bits in a record only mean anything when the
    /// record is the value. A set keeps its representation in its body, so
    /// [`Keyspace::set_encoding`] asks the body, and
    /// [`Keyspace::encoding_name`] is the command that routes between them.
    ///
    /// Every `OBJECT` subcommand looks without touching, so this does too.
    pub fn encoding(&mut self, key: &[u8]) -> Option<Encoding> {
        let addr = self.live_rec_untouched(key)?;
        let rec = self.map.value_at(addr);
        if value::kind(rec) != Kind::String {
            return None;
        }
        Some(value::Meta::from_byte(rec[0]).encoding())
    }

    /// The key's deadline as an absolute unix millisecond, if it has one.
    ///
    /// `EXPIRETIME` and `PEXPIRETIME`, which do not count as using the key. See
    /// [`Keyspace::deadline_of`].
    pub fn expire_at(&mut self, key: &[u8]) -> Option<u64> {
        let addr = self.live_rec_untouched(key)?;
        value::expire_at(self.map.value_at(addr))
    }

    /// `GETRANGE key start end`, and `SUBSTR`, which is the same command.
    ///
    /// Both ends are inclusive and both may be negative, counting back from the
    /// end. Everything out of range clamps, and a start past the end gives the
    /// empty string rather than an error, which is Redis's behaviour and not an
    /// oversight in it.
    ///
    /// Borrowed for a string, owned for an integer, because an integer's digits
    /// do not exist anywhere until somebody asks for them.
    pub fn getrange(&mut self, key: &[u8], start: i64, end: i64) -> Result<Cow<'_, [u8]>> {
        // A range of a demoted value still reads the whole value back, because
        // a chunk is 64 KiB and the range is usually smaller than one. The
        // chunked band can serve a range out of the chunks it covers, and
        // wiring that in here is worth doing once there is a workload asking
        // for windows into large cold values. See [`cold::Reader::range`].
        let Some(v) = self.get(key)? else {
            return Ok(Cow::Borrowed(&[]));
        };
        Ok(match v {
            Str::Bytes(b) => match range_of(b.len(), start, end) {
                Some((s, e)) => Cow::Borrowed(&b[s..e]),
                None => Cow::Borrowed(&[]),
            },
            Str::Int(n) => {
                let text = Str::Int(n).to_vec();
                match range_of(text.len(), start, end) {
                    Some((s, e)) => Cow::Owned(text[s..e].to_vec()),
                    None => Cow::Owned(Vec::new()),
                }
            }
        })
    }

    // ---------------------------------------------------------------- writing

    /// `SET key value [NX|XX] [GET] [IFEQ v|IFNE v|IFDEQ d|IFDNE d]
    /// [EX s|PX ms|EXAT s|PXAT ms|KEEPTTL]`.
    ///
    /// The order the conditions are tested in is Redis's: the key is looked at
    /// once, `NX`, `XX` and the four `IF` forms all decide against that one
    /// look, and `GET` reports what was there whether or not the write went
    /// ahead.
    ///
    /// The old value comes back owned, which costs a copy of it. On the wire
    /// that copy is pure waste, because the reply is written and the bytes are
    /// never looked at again, so the wire calls [`Keyspace::set_with`] instead
    /// and this is that with a `to_vec` on the end.
    pub fn set(&mut self, key: &[u8], val: &[u8], opts: SetOptions<'_>) -> Result<SetOutcome> {
        let mut previous = None;
        let mut out = self.set_with(key, val, opts, |v| previous = Some(v.to_vec()))?;
        out.previous = previous;
        Ok(out)
    }

    /// `SET`, handing the old value to `previous` rather than copying it out.
    ///
    /// [`Keyspace::set`] with the allocation taken off it. `previous` is called
    /// with the value as it lies in the record, before the write goes over it,
    /// and only when `GET` was asked for and there was something there. Nothing
    /// after that point can fail, so a caller that writes the value straight
    /// into a reply is not going to have to take it back out again.
    ///
    /// [`SetOutcome::previous`] is always `None` here. The value went to the
    /// closure, and putting it in both places would be the copy this exists to
    /// avoid.
    pub fn set_with<F>(
        &mut self,
        key: &[u8],
        val: &[u8],
        opts: SetOptions<'_>,
        previous: F,
    ) -> Result<SetOutcome>
    where
        F: FnOnce(Str<'_>),
    {
        check_len(key, val.len())?;
        self.reap(key);
        if opts.get || opts.compare.is_some() {
            // Plain `SET` overwrites whatever was there, but the forms that read
            // the old value first cannot: there is nothing to hand back and
            // nothing to compare against. Redis answers WRONGTYPE for both.
            self.string_only(key)?;
            // And a value on the file has to come back before it can be handed
            // over or compared against. Plain `SET` does not do this, and that
            // is the point: overwriting a demoted key costs no device read.
            self.thaw(key)?;
        }

        let present = self.map.get(key);
        let mut out = SetOutcome::default();
        if opts.get
            && let Some(rec) = present
        {
            previous(value::read(rec));
        }
        let allowed = match opts.exists {
            Exists::Always => true,
            Exists::IfMissing => present.is_none(),
            Exists::IfPresent => present.is_some(),
        };
        let matches = match opts.compare {
            // A key that is not there is not equal to anything, including the
            // empty string, and the `NE` forms read that the other way round.
            Some(c) => c.holds(present.map(value::read)),
            None => true,
        };
        if !allowed || !matches {
            return Ok(out);
        }

        let deadline = match opts.expire {
            Expire::Clear => None,
            Expire::At(ms) => Some(ms),
            Expire::Keep => present.and_then(value::expire_at),
        };
        self.store(key, val, deadline);
        out.stored = true;
        Ok(out)
    }

    /// `SET key value`, with nothing else asked for.
    pub fn set_plain(&mut self, key: &[u8], val: &[u8]) -> Result<()> {
        check_len(key, val.len())?;
        self.store(key, val, None);
        Ok(())
    }

    /// `SETNX key value`, which answers whether it stored.
    pub fn setnx(&mut self, key: &[u8], val: &[u8]) -> Result<bool> {
        Ok(self.set(key, val, SetOptions::PLAIN.if_missing())?.stored)
    }

    /// `SETEX key seconds value`.
    ///
    /// A zero or negative time to live is an error and not a delete, which is
    /// what Redis does: `SETEX k 0 v` returns `ERR invalid expire time`.
    pub fn setex(&mut self, key: &[u8], seconds: i64, val: &[u8]) -> Result<()> {
        let ms = seconds
            .checked_mul(1000)
            .ok_or_else(|| invalid_expire("setex"))?;
        self.set_expiring(key, ms, val, "setex")
    }

    /// `PSETEX key milliseconds value`.
    pub fn psetex(&mut self, key: &[u8], millis: i64, val: &[u8]) -> Result<()> {
        self.set_expiring(key, millis, val, "psetex")
    }

    /// The body both of those share.
    ///
    /// The command name is carried in rather than taken from whichever method
    /// does the work, because the message is the caller's: a `SETEX` with a bad
    /// time to live says `setex` even though the milliseconds are handled here,
    /// and a client that matches on the text gets the command it sent.
    fn set_expiring(&mut self, key: &[u8], millis: i64, val: &[u8], what: &str) -> Result<()> {
        if millis <= 0 {
            return Err(invalid_expire(what));
        }
        let at = self.deadline_in(millis, what)?;
        self.set(key, val, SetOptions::PLAIN.expiring(Expire::At(at)))?;
        Ok(())
    }

    /// `GETSET key value`, which is `SET key value GET` without the options.
    pub fn getset(&mut self, key: &[u8], val: &[u8]) -> Result<Option<Vec<u8>>> {
        Ok(self.set(key, val, SetOptions::PLAIN.returning())?.previous)
    }

    /// `GETDEL key`.
    pub fn getdel(&mut self, key: &[u8]) -> Result<Option<Vec<u8>>> {
        let mut had = None;
        self.getdel_with(key, |v| had = Some(v.to_vec()))?;
        Ok(had)
    }

    /// `GETDEL`, handing the value to `f` rather than copying it out.
    ///
    /// [`Keyspace::getdel`] with the allocation taken off it, the same pair
    /// [`Keyspace::set`] and [`Keyspace::set_with`] are. `f` is called with the
    /// value where it still lies, before the key goes, and the answer says
    /// whether there was one.
    pub fn getdel_with<F>(&mut self, key: &[u8], f: F) -> Result<bool>
    where
        F: FnOnce(Str<'_>),
    {
        self.reap(key);
        self.string_only(key)?;
        // Warmed and not thawed. The key is about to be deleted, so putting its
        // value back in memory on the way past would be work done for a record
        // that is not going to exist a line later.
        self.warm(key)?;
        let Some(v) = self.peek(key) else {
            return Ok(false);
        };
        f(v);
        self.drop_key(key);
        Ok(true)
    }

    /// `GETEX key [EX s|PX ms|EXAT s|PXAT ms|PERSIST]`.
    ///
    /// [`Expire::Keep`] is plain `GETEX`, which reads without touching the
    /// deadline, and [`Expire::Clear`] is `GETEX PERSIST`.
    pub fn getex(&mut self, key: &[u8], expire: Expire) -> Result<Option<Str<'_>>> {
        self.reap(key);
        self.string_only(key)?;
        // Thawed rather than warmed, because a deadline that changes rewrites
        // the whole record: the value does not move but the header in front of
        // it changes length, so the bytes have to be in hand either way. Plain
        // `GETEX` with no expiry argument is the read that the doorkeeper
        // should get a vote on, and it takes the branch below instead.
        if expire == Expire::Keep {
            self.warm(key)?;
        } else {
            self.thaw(key)?;
        }
        if expire != Expire::Keep {
            let current = self.map.get(key).and_then(value::expire_at);
            let wanted = match expire {
                Expire::At(ms) => Some(ms),
                _ => None,
            };
            if current != wanted && self.map.get(key).is_some() {
                // The value does not change, only the header in front of it, so
                // this reads the value out and writes the whole record back. A
                // deadline that is added or removed changes the record's length,
                // so there is nothing to overwrite in place.
                //
                // Through the database's scratch buffer rather than a fresh
                // `Vec`, for the reason `RENAME` does the same thing: the
                // borrow of the map has to end before the write can begin, and
                // a value carried three lines is not worth a malloc and a free.
                let rec = self.map.get(key).expect("checked just above");
                let mut bytes = std::mem::take(&mut self.scratch);
                bytes.clear();
                value::read(rec).write_to(&mut bytes);
                self.store(key, &bytes, wanted);
                self.scratch = bytes;
            }
        }
        Ok(self.peek(key))
    }

    /// `DEL key`, for one key. Answers whether it was there.
    ///
    /// Any type, and it takes the body with it. `DEL` is the one command that
    /// genuinely does not care what it is deleting.
    pub fn del(&mut self, key: &[u8]) -> bool {
        self.reap(key);
        self.drop_key(key)
    }

    /// `MSET key value [key value ...]`.
    ///
    /// Always succeeds, always overwrites, and always clears any deadline the
    /// keys had, which is `SET` without options applied to each pair in turn.
    ///
    /// The pairs arrive as an iterator rather than a slice because the wire
    /// layer has them as positions in the connection's read buffer, and a
    /// slice would mean collecting them into a `Vec` first. `MSET` is on the
    /// list of four commands M2 is measured on, and a shard thread that
    /// allocates aborts, so an API that forces an allocation to call it is the
    /// wrong API. The iterator is walked twice, which is why it has to be
    /// `Clone`, and an iterator over borrowed slices is two words to copy.
    pub fn mset<'k>(
        &mut self,
        pairs: impl Iterator<Item = (&'k [u8], &'k [u8])> + Clone,
    ) -> Result<()> {
        for (k, v) in pairs.clone() {
            check_len(k, v.len())?;
        }
        for (k, v) in pairs {
            self.store(k, v, None);
        }
        Ok(())
    }

    /// `MSETNX key value [key value ...]`, which stores all of them or none.
    ///
    /// The whole set of keys is checked before anything is written, so a
    /// duplicate key inside one call does not defeat itself.
    pub fn msetnx<'k>(
        &mut self,
        pairs: impl Iterator<Item = (&'k [u8], &'k [u8])> + Clone,
    ) -> Result<bool> {
        for (k, v) in pairs.clone() {
            check_len(k, v.len())?;
        }
        for (k, _) in pairs.clone() {
            self.reap(k);
            if self.map.contains(k) {
                return Ok(false);
            }
        }
        for (k, v) in pairs {
            self.store(k, v, None);
        }
        Ok(true)
    }

    /// `APPEND key value`, answering the new length.
    ///
    /// Appending to a key that is not there creates it, which makes `APPEND` on
    /// an empty key the same as `SET`. Any deadline the key had is kept, which
    /// is Redis's behaviour: `APPEND` is not a fresh `SET`.
    pub fn append(&mut self, key: &[u8], tail: &[u8]) -> Result<usize> {
        self.reap(key);
        self.string_only(key)?;
        self.thaw(key)?;
        let Some(rec) = self.map.get(key) else {
            check_len(key, tail.len())?;
            self.store(key, tail, None);
            return Ok(tail.len());
        };
        let deadline = value::expire_at(rec);
        // The database's one scratch buffer, for the reason `LMOVE` uses it:
        // building the new value needs the old bytes in hand while `store_raw`
        // wants `&mut self`, and a `Vec` per call is a malloc and a free on the
        // command a log writer sends in a loop. Taken out and put back on every
        // path, so an early return leaves it as it was found.
        let mut joined = std::mem::take(&mut self.scratch);
        joined.clear();
        value::read(rec).write_to(&mut joined);
        if let Err(e) = check_len(key, joined.len() + tail.len()) {
            self.scratch = joined;
            return Err(e);
        }
        joined.extend_from_slice(tail);
        let len = joined.len();
        self.store_raw(key, &joined, deadline);
        self.scratch = joined;
        Ok(len)
    }

    /// `SETRANGE key offset value`, answering the new length.
    ///
    /// A write past the end pads with zero bytes, and a write of nothing to a
    /// key that is not there creates nothing and answers zero. Both of those are
    /// Redis's, and both are the kind of edge a client library's test suite
    /// checks.
    pub fn setrange(&mut self, key: &[u8], offset: usize, val: &[u8]) -> Result<usize> {
        self.reap(key);
        self.string_only(key)?;
        // `SETRANGE key n ""` writes nothing and answers the length, which the
        // record already knows, so that form does not touch the device. See
        // [`Keyspace::strlen`], which is the same argument.
        if val.is_empty() {
            return Ok(self.strlen(key).unwrap_or(0));
        }
        self.thaw(key)?;
        let end = offset
            .checked_add(val.len())
            .ok_or_else(|| Error::new(Code::Invalid, BAD_OFFSET))?;
        check_len(key, end)?;

        // The same scratch buffer [`Keyspace::append`] uses, for the same
        // reason. `SETRANGE` in a loop is how a client keeps a fixed layout
        // record in one key.
        let mut bytes = std::mem::take(&mut self.scratch);
        bytes.clear();
        let deadline = match self.map.get(key) {
            Some(rec) => {
                value::read(rec).write_to(&mut bytes);
                value::expire_at(rec)
            }
            None => None,
        };
        if bytes.len() < end {
            bytes.resize(end, 0);
        }
        bytes[offset..end].copy_from_slice(val);
        let len = bytes.len();
        self.store_raw(key, &bytes, deadline);
        self.scratch = bytes;
        Ok(len)
    }

    // --------------------------------------------------------------- counters

    /// `INCR key`.
    #[inline]
    pub fn incr(&mut self, key: &[u8]) -> Result<i64> {
        self.incrby(key, 1)
    }

    /// `DECR key`.
    #[inline]
    pub fn decr(&mut self, key: &[u8]) -> Result<i64> {
        self.decrby(key, 1)
    }

    /// `DECRBY key decrement`.
    ///
    /// Negating first would overflow on `i64::MIN`, which is why the decrement
    /// is carried through as a subtraction rather than turned into an addition.
    pub fn decrby(&mut self, key: &[u8], by: i64) -> Result<i64> {
        self.count(key, by, true)
    }

    /// `INCRBY key increment`, and with an increment of one, `INCR`.
    ///
    /// This is the command the milestone's gate is about, so the path it takes
    /// is worth stating. A key that is already int encoded is one probe, an add
    /// and an eight byte store back into the record the probe landed on. No
    /// arena allocation, no free, no second record, and no rehash. Every other
    /// case falls through to a rewrite, which is what `INCR` on a string that
    /// happens to look like a number costs.
    #[inline]
    pub fn incrby(&mut self, key: &[u8], by: i64) -> Result<i64> {
        self.count(key, by, false)
    }

    fn count(&mut self, key: &[u8], by: i64, subtract: bool) -> Result<i64> {
        check_len(key, 0)?;
        // A demoted value is never int encoded, so a counter that is being
        // counted on is never on the file and this costs one branch on a null
        // field. It is here for the key that was a long string, got demoted,
        // and is now being incremented, which answers an error rather than
        // reading twelve bytes of address as a number.
        self.thaw(key)?;
        let hash = RawMap::hash_of(key);
        let now = self.clock.now_ms();

        // One probe, and the mutable borrow ends inside this block whichever way
        // it goes, so the slow paths below are free to reallocate.
        let mut current: Option<i64> = None;
        let mut deadline: Option<u64> = None;
        let mut dead = false;
        if let Some(rec) = self.map.value_mut_hashed(hash, key) {
            // The type check is inside the probe rather than in front of it,
            // which is what the other writers do with `string_only`. The kind is
            // three bits of the same byte the expiry flag is in, and that byte
            // has already been loaded by the time this is asked, so here it is
            // free. In front of the probe it measured at one and a half
            // nanoseconds on a command that runs in eighteen, which is eight per
            // cent of the number M2's gate is written against.
            if value::kind(rec) != Kind::String {
                return Err(wrong_type());
            }
            if value::is_expired(rec, now) {
                dead = true;
            } else {
                deadline = value::expire_at(rec);
                match value::read_int_in_place(rec) {
                    Some((n, at)) => {
                        let next = step(n, by, subtract)?;
                        value::write_int_in_place(rec, at, next);
                        return Ok(next);
                    }
                    None => {
                        current = Some(
                            value::read(rec)
                                .as_int()
                                .ok_or_else(|| Error::new(Code::Invalid, NOT_AN_INT))?,
                        );
                    }
                }
            }
        }

        if dead {
            self.drop_key(key);
            self.expired += 1;
            deadline = None;
        }
        let next = step(current.unwrap_or(0), by, subtract)?;
        self.store_int(key, next, deadline);
        Ok(next)
    }

    /// `INCRBYFLOAT key increment`.
    ///
    /// The result is stored as a string, never as an integer, because Redis
    /// stores it with its own formatting and `OBJECT ENCODING` reports `embstr`
    /// afterwards even when the number came out whole.
    pub fn incrbyfloat(&mut self, key: &[u8], by: f64) -> Result<f64> {
        check_len(key, 0)?;
        // An infinite increment is not refused up front. Redis parses it,
        // performs the addition and reports the sum, so `INCRBYFLOAT k inf`
        // says the increment would produce infinity rather than that the
        // increment is not a float, and the check below is the one that says
        // it.
        self.reap(key);
        self.string_only(key)?;
        self.thaw(key)?;
        let (current, deadline) = match self.map.get(key) {
            Some(rec) => {
                // Read out of the record rather than copied out of it. An int
                // encoded value has no digits anywhere to borrow, so that arm
                // converts instead of formatting and parsing, which is the same
                // double either way: the decimal form of an `i64` rounds to the
                // nearest double and so does the cast.
                let n = match value::read(rec) {
                    Str::Int(n) => n as f64,
                    Str::Bytes(b) => {
                        parse_f64(b).ok_or_else(|| Error::new(Code::Invalid, NOT_A_FLOAT))?
                    }
                };
                (n, value::expire_at(rec))
            }
            None => (0.0, None),
        };
        let next = current + by;
        if !next.is_finite() {
            return Err(Error::new(
                Code::Invalid,
                "increment would produce NaN or Infinity",
            ));
        }
        let mut buf = [0u8; yo_common::num::DOUBLE_MAX];
        let text = yo_common::num::write_double(&mut buf, next);
        self.store_text(key, text, deadline);
        Ok(next)
    }

    // ------------------------------------------------------------------- 8.4+

    /// `MSETEX numkeys key value [key value ...] [NX|XX]
    /// [EX s|PX ms|EXAT s|PXAT ms|KEEPTTL]`.
    ///
    /// Redis 8.4. `MSET` with a condition and a shared deadline, and the
    /// condition is over the whole set rather than per key: `NX` needs every
    /// key to be missing and `XX` needs every one to be present, and a partial
    /// match writes nothing and answers false. Without an expiration option the
    /// deadline is cleared, the same way plain `SET` clears it, and
    /// [`Expire::Keep`] is `KEEPTTL`, which leaves each key its own.
    ///
    /// A duplicate key inside one call is not an error and the last value wins.
    pub fn msetex<'k>(
        &mut self,
        pairs: impl Iterator<Item = (&'k [u8], &'k [u8])> + Clone,
        exists: Exists,
        expire: Expire,
    ) -> Result<bool> {
        for (k, v) in pairs.clone() {
            check_len(k, v.len())?;
        }
        for (k, _) in pairs.clone() {
            self.reap(k);
        }
        let allowed = match exists {
            Exists::Always => true,
            Exists::IfMissing => pairs.clone().all(|(k, _)| !self.map.contains(k)),
            Exists::IfPresent => pairs.clone().all(|(k, _)| self.map.contains(k)),
        };
        if !allowed {
            return Ok(false);
        }
        for (k, v) in pairs {
            let deadline = match expire {
                Expire::Clear => None,
                Expire::At(ms) => Some(ms),
                Expire::Keep => self.map.get(k).and_then(value::expire_at),
            };
            self.store(k, v, deadline);
        }
        Ok(true)
    }

    /// `DELEX key [IFEQ v|IFNE v|IFDEQ d|IFDNE d]`.
    ///
    /// Redis 8.4's compare and delete, the other half of `SET ... IFEQ`. The
    /// point of it is the read modify write nobody was doing correctly: a client
    /// that reads a value, decides it is stale and deletes it can be beaten to
    /// the key by another client between the read and the delete, and `WATCH`
    /// plus `MULTI` costs a round trip to avoid it.
    ///
    /// `None` compares against nothing and deletes unconditionally, which is
    /// plain `DEL` for one key. A key that is not there answers false whatever
    /// the condition says, including the `NE` forms that a missing key
    /// satisfies, because there is still nothing to delete.
    pub fn delex(&mut self, key: &[u8], compare: Option<Compare<'_>>) -> bool {
        self.reap(key);
        // Only the comparing form reads the value, and only that form pays for
        // a demoted one. `DELEX` with no compare deletes a cold key without
        // touching the file at all. An error faulting is a comparison that
        // cannot be made, which is a comparison that does not hold.
        let matches = match compare {
            Some(c) => {
                if self.warm(key).is_err() {
                    return false;
                }
                c.holds(self.peek(key))
            }
            None => true,
        };
        matches && self.drop_key(key)
    }

    /// `DIGEST key`, the XXH3 of the value.
    ///
    /// Redis 8.4, and the reason it exists is `IFDEQ`: a client that wants to
    /// compare and swap against a large value sends eight bytes instead of the
    /// value. `None` is a key that is not there, which is a nil reply.
    pub fn digest(&mut self, key: &[u8]) -> Result<Option<u64>> {
        self.reap(key);
        self.string_only(key)?;
        // The digest is over the value, so a demoted one has to be read back.
        // Warmed and not thawed: a client polling a digest to see whether a
        // large value has changed is exactly the read the doorkeeper is for.
        self.warm(key)?;
        Ok(self.peek(key).map(|v| v.digest()))
    }

    /// `INCREX key [BYINT n|BYFLOAT f] [SATURATE] [LBOUND l] [UBOUND u]
    /// [EX s|PX ms|EXAT s|PXAT ms|PERSIST] [ENX]`.
    ///
    /// Redis 8.8, and the first Redis primitive that implements a workload
    /// rather than a data structure. What it replaces is `INCR` followed by
    /// `EXPIRE`, which is two round trips, or a Lua script, which is one round
    /// trip and a script cache.
    ///
    /// The rate limiter is `INCREX key EX window ENX`: the counter goes up, and
    /// the window is started only when the key had no deadline, so a burst
    /// inside one window expires together at the deadline the first call set
    /// rather than each call pushing it out. The quota counter is `UBOUND`
    /// without `SATURATE`, which refuses rather than clamping and reports zero
    /// applied. The stock level is `LBOUND 0 SATURATE`, which takes what it can.
    ///
    /// A refused increment writes nothing at all: it does not create the key and
    /// it does not touch the deadline of a key that was there.
    pub fn increx(&mut self, key: &[u8], opts: IncrEx) -> Result<Counted> {
        check_len(key, 0)?;
        self.reap(key);
        self.string_only(key)?;
        self.thaw(key)?;

        let (current, had_deadline) = match self.map.get(key) {
            Some(rec) => {
                let v = value::read(rec);
                let now = if opts.by.is_int() {
                    Num::Int(
                        v.as_int()
                            .ok_or_else(|| Error::new(Code::Invalid, NOT_AN_INT))?,
                    )
                } else {
                    let text = v.to_vec();
                    Num::Float(
                        parse_f64(&text).ok_or_else(|| Error::new(Code::Invalid, NOT_A_FLOAT))?,
                    )
                };
                (now, value::expire_at(rec))
            }
            None => (
                if opts.by.is_int() {
                    Num::Int(0)
                } else {
                    Num::Float(0.0)
                },
                None,
            ),
        };

        let out = counter::apply(current, &opts)?;
        if !out.stored {
            return Ok(out);
        }

        let deadline = match opts.expire {
            IncrExpire::Keep => had_deadline,
            IncrExpire::Persist => None,
            IncrExpire::At(ms) => Some(ms),
            IncrExpire::AtIfNone(ms) => had_deadline.or(Some(ms)),
        };
        match out.value {
            Num::Int(n) => self.store_int(key, n, deadline),
            Num::Float(f) => {
                // Stored as text and never as an integer, for the same reason
                // `INCRBYFLOAT` is: Redis reports `embstr` afterwards even when
                // the number came out whole.
                let mut buf = [0u8; yo_common::num::DOUBLE_MAX];
                let text = yo_common::num::write_double(&mut buf, f);
                self.store_text(key, text, deadline);
            }
        }
        Ok(out)
    }

    /// `LCS key1 key2`, the longest common subsequence itself.
    ///
    /// A key that is not there is the empty string, which is Redis's reading and
    /// not an error.
    pub fn lcs(&mut self, a: &[u8], b: &[u8]) -> Result<Vec<u8>> {
        let (x, y) = self.both(a, b)?;
        lcs::string(&x, &y)
    }

    /// `LCS key1 key2 LEN`.
    pub fn lcs_len(&mut self, a: &[u8], b: &[u8]) -> Result<usize> {
        let (x, y) = self.both(a, b)?;
        lcs::len(&x, &y)
    }

    /// `LCS key1 key2 IDX [MINMATCHLEN n]`.
    ///
    /// `WITHMATCHLEN` is not a parameter here because every run comes back with
    /// its length attached. Whether that length reaches the client is the reply
    /// writer's decision and not the store's.
    pub fn lcs_idx(&mut self, a: &[u8], b: &[u8], minmatchlen: u32) -> Result<lcs::Idx> {
        let (x, y) = self.both(a, b)?;
        lcs::idx(&x, &y, minmatchlen)
    }

    /// Both values as bytes, for the one command that needs two keys at once.
    ///
    /// Copied rather than borrowed, which is the only place in this file that
    /// copies a value it did not have to. `LCS` builds a table the size of the
    /// product of the two lengths, so a pair of copies is not what makes it
    /// expensive, and borrowing both at once through a `&mut self` reap is a
    /// fight with the borrow checker for no measurable gain.
    fn both(&mut self, a: &[u8], b: &[u8]) -> Result<(Vec<u8>, Vec<u8>)> {
        self.reap(a);
        self.reap(b);
        self.string_only(a)?;
        self.string_only(b)?;
        // One key at a time, because there is one buffer and this needs two
        // values. Each is copied out before the next is faulted, which is the
        // one place in this file that copies a value it did not have to and it
        // was already copying before any of this.
        self.warm(a)?;
        let x = self.peek(a).map(|v| v.to_vec()).unwrap_or_default();
        self.warm(b)?;
        let y = self.peek(b).map(|v| v.to_vec()).unwrap_or_default();
        Ok((x, y))
    }

    // ---------------------------------------------------------------- private

    /// The string under `key` without reaping first.
    ///
    /// Every public read reaps before calling this, so a caller that skips the
    /// reap would be reading a value the clock says is gone.
    ///
    /// A key holding something else answers `None` and not the first few bytes
    /// of a slab number read as a string. That is the right answer for `MGET`,
    /// which Redis documents as giving nil for a key of the wrong type rather
    /// than failing the whole command, and it is not the right answer for `GET`,
    /// which is why the readers that owe a `WRONGTYPE` ask
    /// [`Keyspace::string_only`] first.
    ///
    /// A key whose value is on the file has to have been through
    /// [`Keyspace::warm`] or [`Keyspace::thaw`] before this is called, because
    /// this reads a served value out of the database's one buffer and nothing
    /// in the buffer says whose value it is. A debug build asserts it. On a
    /// database with no file behind it there are no cold records and this is
    /// exactly what it always was.
    #[inline]
    pub(crate) fn peek(&self, key: &[u8]) -> Option<Str<'_>> {
        let rec = self.map.get(key)?;
        if value::kind(rec) != Kind::String {
            return None;
        }
        Some(self.value_of(key, rec))
    }

    /// Fail with `WRONGTYPE` if `key` holds something that is not a string.
    ///
    /// A missing key passes, because every string command treats a missing key
    /// as an empty one and none of them care what type it is not.
    ///
    /// The early return is the point. A database with no sets, no hashes and no
    /// lists in it cannot be holding the wrong type under any key, so the check
    /// is one branch on a counter this struct already has in cache, and no
    /// lookup at all. Once one set exists every string command pays a lookup it
    /// did not pay before, which is the cost of being able to say no.
    ///
    /// [`Keyspace::count`] does not use this and reads the kind out of the
    /// record its own probe returned instead. Both are correct and the reason
    /// for the difference is measured rather than stylistic: `INCR` runs in
    /// eighteen nanoseconds and the branch here cost it one and a half of them,
    /// where inside the probe the byte is already loaded and it costs nothing.
    /// Every other writer is long enough that it does not show, so they take the
    /// version that reads as one line.
    #[inline]
    pub(crate) fn string_only(&self, key: &[u8]) -> Result<()> {
        if self.bodies == 0 {
            return Ok(());
        }
        match self.map.get(key) {
            Some(rec) if value::kind(rec) != Kind::String => Err(wrong_type()),
            _ => Ok(()),
        }
    }

    /// Store `val` under `key`, choosing the encoding from the bytes.
    pub(crate) fn store(&mut self, key: &[u8], val: &[u8], deadline: Option<u64>) {
        let enc = Encoding::of(val);
        let len = value::record_len(enc, val.len(), deadline.is_some());
        self.free_body(key);
        self.write_rec(key, len, |out| {
            value::write_record(out, enc, val, deadline);
        });
    }

    /// Store `val` under `key` as text, choosing `embstr` or `raw` by length
    /// but never int encoding it.
    ///
    /// This is what the float counters do. `INCRBYFLOAT k 1` on `5` leaves `6`,
    /// and a real server reports `embstr` for it and not `int`, because the
    /// result went through Redis's own formatter and straight into a string
    /// object without being offered to `tryObjectEncoding`.
    fn store_text(&mut self, key: &[u8], val: &[u8], deadline: Option<u64>) {
        let enc = if val.len() <= value::EMBSTR_MAX {
            Encoding::Embstr
        } else {
            Encoding::Raw
        };
        let len = value::record_len(enc, val.len(), deadline.is_some());
        self.free_body(key);
        self.write_rec(key, len, |out| {
            value::write_record(out, enc, val, deadline);
        });
    }

    /// Store `val` under `key` as a `raw` string whatever its length.
    ///
    /// `APPEND` and `SETRANGE` both leave `raw` behind in Redis even for a four
    /// byte result, because they build the value with `sdscatlen` and the
    /// object never goes back through the encoder. `OBJECT ENCODING` is tested
    /// on exactly that.
    pub(crate) fn store_raw(&mut self, key: &[u8], val: &[u8], deadline: Option<u64>) {
        let len = value::record_len(Encoding::Raw, val.len(), deadline.is_some());
        self.free_body(key);
        self.write_rec(key, len, |out| {
            value::write_record(out, Encoding::Raw, val, deadline);
        });
    }

    /// Store an integer the caller already has, without formatting it first.
    fn store_int(&mut self, key: &[u8], n: i64, deadline: Option<u64>) {
        let len = value::record_len(Encoding::Int, 0, deadline.is_some());
        self.free_body(key);
        self.write_rec(key, len, |out| {
            value::write_int_record(out, n, deadline);
        });
    }

    /// `millis` from now, as an absolute unix millisecond.
    fn deadline_in(&self, millis: i64, what: &str) -> Result<u64> {
        u64::try_from(millis)
            .ok()
            .and_then(|ms| self.clock.now_ms().checked_add(ms))
            .ok_or_else(|| invalid_expire(what))
    }
}

/// Add or subtract, refusing to wrap.
#[inline]
fn step(n: i64, by: i64, subtract: bool) -> Result<i64> {
    let r = if subtract {
        n.checked_sub(by)
    } else {
        n.checked_add(by)
    };
    r.ok_or_else(|| Error::new(Code::Invalid, WOULD_OVERFLOW))
}

/// Refuse a key or a value this band cannot hold.
///
/// Not string only. The key limit is the keyspace's and applies to every type,
/// and a set member is held the same way a string is, so [`crate::sets`] checks
/// against this rather than growing a second copy of the same two numbers.
#[inline]
pub(crate) fn check_len(key: &[u8], len: usize) -> Result<()> {
    if key.len() > KEY_MAX {
        return Err(Error::new(Code::Full, KEY_TOO_LONG));
    }
    if len > STRING_MAX {
        return Err(Error::new(Code::Full, TOO_LONG));
    }
    Ok(())
}

fn invalid_expire(what: &str) -> Error {
    Error::fmt(
        Code::Invalid,
        format_args!("invalid expire time in '{what}' command"),
    )
}

/// Turn Redis's inclusive, possibly negative range into a half open one.
///
/// Returns `None` when the range selects nothing, which the caller answers with
/// the empty string.
fn range_of(len: usize, start: i64, end: i64) -> Option<(usize, usize)> {
    if len == 0 {
        return None;
    }
    let n = len as i64;
    let clamp = |i: i64| -> i64 { if i < 0 { (n + i).max(0) } else { i.min(n) } };
    let s = clamp(start);
    // The end is inclusive, so one past it is where the slice stops.
    let e = if end < 0 {
        (n + end + 1).max(0)
    } else {
        (end + 1).min(n)
    };
    if s >= e {
        None
    } else {
        Some((s as usize, e as usize))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::clock::Clock;
    use crate::value::EMBSTR_MAX;

    /// A store on a fixed clock, so expiry is a function of what the test does
    /// and not of how long the test takes to run.
    fn store() -> Keyspace {
        Keyspace::with_clock(Clock::fixed(1_000))
    }

    fn got(s: &mut Keyspace, key: &[u8]) -> Option<Vec<u8>> {
        s.get(key)
            .expect("a string in these tests")
            .map(|v| v.to_vec())
    }

    #[test]
    fn set_and_get_round_trip() {
        let mut s = store();
        assert_eq!(got(&mut s, b"k"), None);
        s.set_plain(b"k", b"hello").unwrap();
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"hello"[..]));
        assert_eq!(s.strlen(b"k").expect("a string"), 5);
        assert_eq!(s.len(), 1);
        s.set_plain(b"k", b"bye").unwrap();
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"bye"[..]));
        assert_eq!(s.len(), 1, "overwriting made a second key");
    }

    #[test]
    fn a_value_comes_back_exactly_as_it_went_in() {
        let mut s = store();
        for text in [&b""[..], b"0", b"007", b"-0", b"+1", b"9223372036854775808"] {
            s.set_plain(b"k", text).unwrap();
            assert_eq!(got(&mut s, b"k").as_deref(), Some(text), "{text:?}");
        }
    }

    #[test]
    fn object_encoding_matches_redis() {
        let mut s = store();
        s.set_plain(b"n", b"42").unwrap();
        assert_eq!(s.encoding(b"n"), Some(Encoding::Int));
        s.set_plain(b"z", b"007").unwrap();
        assert_eq!(s.encoding(b"z"), Some(Encoding::Embstr));
        s.set_plain(b"e", &[b'x'; EMBSTR_MAX]).unwrap();
        assert_eq!(s.encoding(b"e"), Some(Encoding::Embstr));
        s.set_plain(b"r", &[b'x'; EMBSTR_MAX + 1]).unwrap();
        assert_eq!(s.encoding(b"r"), Some(Encoding::Raw));
        assert_eq!(s.encoding(b"missing"), None);
        // What APPEND leaves behind is raw even though it reads as a number.
        s.set_plain(b"a", b"1").unwrap();
        s.append(b"a", b"2").unwrap();
        assert_eq!(s.encoding(b"a"), Some(Encoding::Raw));
    }

    #[test]
    fn nx_and_xx_decide_against_what_is_there() {
        let mut s = store();
        assert!(
            !s.set(b"k", b"v", SetOptions::PLAIN.if_present())
                .unwrap()
                .stored
        );
        assert_eq!(got(&mut s, b"k"), None);
        assert!(
            s.set(b"k", b"v", SetOptions::PLAIN.if_missing())
                .unwrap()
                .stored
        );
        assert!(
            !s.set(b"k", b"w", SetOptions::PLAIN.if_missing())
                .unwrap()
                .stored
        );
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"v"[..]));
        assert!(
            s.set(b"k", b"w", SetOptions::PLAIN.if_present())
                .unwrap()
                .stored
        );
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"w"[..]));
        assert!(s.setnx(b"fresh", b"1").unwrap());
        assert!(!s.setnx(b"fresh", b"2").unwrap());
    }

    #[test]
    fn ifeq_compares_against_the_string_the_client_would_have_read() {
        let mut s = store();
        // A key that is not there is not equal to anything.
        assert!(
            !s.set(b"k", b"v", SetOptions::PLAIN.if_equal(b""))
                .unwrap()
                .stored
        );
        s.set_plain(b"k", b"42").unwrap();
        assert!(
            !s.set(b"k", b"v", SetOptions::PLAIN.if_equal(b"43"))
                .unwrap()
                .stored
        );
        // Int encoded, so the comparison is against the digits and not the bytes
        // in the record, and "042" is not "42".
        assert!(
            !s.set(b"k", b"v", SetOptions::PLAIN.if_equal(b"042"))
                .unwrap()
                .stored
        );
        assert!(
            s.set(b"k", b"v", SetOptions::PLAIN.if_equal(b"42"))
                .unwrap()
                .stored
        );
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"v"[..]));
    }

    #[test]
    fn get_reports_the_old_value_whether_or_not_the_write_happened() {
        let mut s = store();
        assert_eq!(
            s.set(b"k", b"a", SetOptions::PLAIN.returning())
                .unwrap()
                .previous,
            None
        );
        let out = s.set(b"k", b"b", SetOptions::PLAIN.returning()).unwrap();
        assert!(out.stored);
        assert_eq!(out.previous.as_deref(), Some(&b"a"[..]));
        // Refused by NX, and still reports what is there.
        let out = s
            .set(b"k", b"c", SetOptions::PLAIN.if_missing().returning())
            .unwrap();
        assert!(!out.stored);
        assert_eq!(out.previous.as_deref(), Some(&b"b"[..]));
        assert_eq!(s.getset(b"k", b"d").unwrap().as_deref(), Some(&b"b"[..]));
    }

    #[test]
    fn a_key_is_gone_the_millisecond_its_deadline_arrives() {
        let mut s = store();
        s.set(b"k", b"v", SetOptions::PLAIN.expiring(Expire::At(1_500)))
            .unwrap();
        assert_eq!(s.expire_at(b"k"), Some(1_500));
        s.clock_mut().set(1_499);
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"v"[..]));
        s.clock_mut().set(1_500);
        assert_eq!(got(&mut s, b"k"), None);
        assert_eq!(s.len(), 0, "the dead key was not reclaimed");
        assert_eq!(s.expired_keys(), 1);
    }

    #[test]
    fn keepttl_keeps_the_deadline_and_a_plain_set_clears_it() {
        let mut s = store();
        s.set(b"k", b"v", SetOptions::PLAIN.expiring(Expire::At(9_000)))
            .unwrap();
        s.set(b"k", b"w", SetOptions::PLAIN.expiring(Expire::Keep))
            .unwrap();
        assert_eq!(s.expire_at(b"k"), Some(9_000));
        s.set_plain(b"k", b"x").unwrap();
        assert_eq!(s.expire_at(b"k"), None);
    }

    #[test]
    fn setex_refuses_a_time_to_live_that_is_not_one() {
        let mut s = store();
        // The command in the message is the one that was called, lower cased,
        // even though `SETEX` hands the milliseconds to the same body `PSETEX`
        // uses.
        assert_eq!(
            s.setex(b"k", 0, b"v").unwrap_err().message(),
            "invalid expire time in 'setex' command"
        );
        assert_eq!(
            s.psetex(b"k", 0, b"v").unwrap_err().message(),
            "invalid expire time in 'psetex' command"
        );
        assert!(s.setex(b"k", -1, b"v").is_err());
        assert_eq!(got(&mut s, b"k"), None);
        s.setex(b"k", 10, b"v").unwrap();
        assert_eq!(s.expire_at(b"k"), Some(11_000));
        s.psetex(b"p", 250, b"v").unwrap();
        assert_eq!(s.expire_at(b"p"), Some(1_250));
    }

    #[test]
    fn getex_reads_and_retimes_in_one_go() {
        let mut s = store();
        s.set(b"k", b"v", SetOptions::PLAIN.expiring(Expire::At(5_000)))
            .unwrap();
        // Plain GETEX leaves the deadline alone.
        assert_eq!(
            s.getex(b"k", Expire::Keep)
                .expect("a string")
                .map(|v| v.to_vec())
                .as_deref(),
            Some(&b"v"[..])
        );
        assert_eq!(s.expire_at(b"k"), Some(5_000));
        // PERSIST clears it.
        assert!(s.getex(b"k", Expire::Clear).expect("a string").is_some());
        assert_eq!(s.expire_at(b"k"), None);
        // And a new deadline replaces it.
        assert!(
            s.getex(b"k", Expire::At(7_000))
                .expect("a string")
                .is_some()
        );
        assert_eq!(s.expire_at(b"k"), Some(7_000));
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"v"[..]));
        assert!(
            s.getex(b"missing", Expire::At(7_000))
                .expect("a string")
                .is_none()
        );
    }

    #[test]
    fn getdel_hands_the_value_over_and_keeps_nothing() {
        let mut s = store();
        s.set_plain(b"k", b"v").unwrap();
        assert_eq!(
            s.getdel(b"k").expect("a string").as_deref(),
            Some(&b"v"[..])
        );
        assert_eq!(s.getdel(b"k").expect("a string"), None);
        assert_eq!(s.len(), 0);
        s.set_plain(b"k", b"v").unwrap();
        assert!(s.del(b"k"));
        assert!(!s.del(b"k"));
    }

    #[test]
    fn mset_writes_every_pair_and_msetnx_writes_none_of_them() {
        let mut s = store();
        s.mset([(&b"a"[..], &b"1"[..]), (&b"b"[..], &b"2"[..])].into_iter())
            .unwrap();
        let vals = s.mget(&[&b"a"[..], &b"b"[..], &b"missing"[..]]);
        let vals: Vec<_> = vals.iter().map(|v| v.map(|v| v.to_vec())).collect();
        assert_eq!(vals[0].as_deref(), Some(&b"1"[..]));
        assert_eq!(vals[1].as_deref(), Some(&b"2"[..]));
        assert_eq!(vals[2], None);

        assert!(
            !s.msetnx([(&b"b"[..], &b"9"[..]), (&b"c"[..], &b"3"[..])].into_iter())
                .unwrap()
        );
        assert_eq!(got(&mut s, b"c"), None, "msetnx wrote part of the set");
        assert_eq!(got(&mut s, b"b").as_deref(), Some(&b"2"[..]));
        assert!(
            s.msetnx([(&b"c"[..], &b"3"[..]), (&b"d"[..], &b"4"[..])].into_iter())
                .unwrap()
        );
        assert_eq!(got(&mut s, b"d").as_deref(), Some(&b"4"[..]));
    }

    #[test]
    fn mget_reaps_before_it_reads() {
        let mut s = store();
        s.set(b"a", b"1", SetOptions::PLAIN.expiring(Expire::At(1_100)))
            .unwrap();
        s.set_plain(b"b", b"2").unwrap();
        s.clock_mut().set(1_100);
        let vals = s.mget(&[&b"a"[..], &b"b"[..]]);
        assert!(vals[0].is_none(), "a dead key came back from mget");
        assert!(vals[1].is_some());
        assert_eq!(s.len(), 1);
    }

    #[test]
    fn append_creates_extends_and_keeps_the_deadline() {
        let mut s = store();
        assert_eq!(s.append(b"k", b"one").unwrap(), 3);
        assert_eq!(s.append(b"k", b" two").unwrap(), 7);
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"one two"[..]));
        s.set(b"t", b"a", SetOptions::PLAIN.expiring(Expire::At(4_000)))
            .unwrap();
        s.append(b"t", b"b").unwrap();
        assert_eq!(s.expire_at(b"t"), Some(4_000));
        assert_eq!(got(&mut s, b"t").as_deref(), Some(&b"ab"[..]));
    }

    /// `APPEND` in a loop is how a client writes a log into one key, so the
    /// copy of the old value it has to make must not be a fresh `Vec` every
    /// time. The value keeps growing here, so the scratch buffer and the index
    /// are both still allowed to grow, which is why this counts a ceiling rather
    /// than zero. Before the scratch buffer it was a hundred and change.
    #[test]
    fn append_reuses_its_buffer_instead_of_allocating_per_call() {
        let mut s = store();
        s.append(b"k", b"start").expect("room");
        let (_, allocs) = crate::tally::counted(|| {
            for _ in 0..100 {
                s.append(b"k", b"0123456789").expect("room");
            }
        });
        assert!(
            allocs < 20,
            "append allocated {allocs} times in a hundred, so it is still copying into a new Vec"
        );
        assert_eq!(got(&mut s, b"k").map(|v| v.len()), Some(1005));
    }

    /// The same claim for `SETRANGE`, which is easier to state because the value
    /// does not grow: writing over the same five bytes of the same key a hundred
    /// times has nothing left to allocate for.
    #[test]
    fn setrange_stops_allocating_once_its_buffer_is_grown() {
        let mut s = store();
        s.set_plain(b"k", b"Hello World").expect("room");
        s.setrange(b"k", 6, b"Redis").expect("room");
        let (_, allocs) = crate::tally::counted(|| {
            for _ in 0..100 {
                s.setrange(b"k", 6, b"Redis").expect("room");
            }
        });
        assert_eq!(allocs, 0, "setrange allocated {allocs} times in a hundred");
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"Hello Redis"[..]));
    }

    /// `EXPIRE` on a string rewrites the record, which means holding the value
    /// while it does. A cache that sets a deadline on every write sends as many
    /// of these as it does `SET`.
    #[test]
    fn expiry_on_a_string_stops_allocating_once_its_buffer_is_grown() {
        let mut s = store();
        s.set_plain(b"k", b"a value of some length").expect("room");
        // Far enough out that the key is still there at the end. A deadline in
        // the past is reaped, and a reaped key is a different test.
        const FUTURE: u64 = 4_000_000_000_000;
        s.set_expiry(b"k", Some(FUTURE));
        let (_, allocs) = crate::tally::counted(|| {
            for i in 0..100 {
                // A different deadline each time, because the same one is a no
                // op that never reaches the rewrite.
                s.set_expiry(b"k", Some(FUTURE + i));
            }
        });
        assert_eq!(
            allocs, 0,
            "set_expiry allocated {allocs} times in a hundred"
        );
        assert_eq!(
            got(&mut s, b"k").as_deref(),
            Some(&b"a value of some length"[..])
        );
    }

    #[test]
    fn setrange_pads_with_zero_bytes() {
        let mut s = store();
        assert_eq!(s.setrange(b"k", 0, b"").unwrap(), 0);
        assert_eq!(got(&mut s, b"k"), None, "an empty write created a key");
        assert_eq!(s.setrange(b"k", 3, b"xy").unwrap(), 5);
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"\0\0\0xy"[..]));
        s.set_plain(b"h", b"Hello World").unwrap();
        assert_eq!(s.setrange(b"h", 6, b"Redis").unwrap(), 11);
        assert_eq!(got(&mut s, b"h").as_deref(), Some(&b"Hello Redis"[..]));
    }

    #[test]
    fn getrange_counts_from_both_ends_and_clamps() {
        let mut s = store();
        s.set_plain(b"k", b"This is a string").unwrap();
        assert_eq!(&*s.getrange(b"k", 0, 3).expect("a string"), b"This");
        assert_eq!(&*s.getrange(b"k", -3, -1).expect("a string"), b"ing");
        assert_eq!(
            &*s.getrange(b"k", 0, -1).expect("a string"),
            b"This is a string"
        );
        assert_eq!(&*s.getrange(b"k", 10, 100).expect("a string"), b"string");
        // A start past the end, and a range that runs backwards, are both empty.
        assert_eq!(&*s.getrange(b"k", 100, 200).expect("a string"), b"");
        assert_eq!(&*s.getrange(b"k", 5, 2).expect("a string"), b"");
        assert_eq!(&*s.getrange(b"missing", 0, -1).expect("a string"), b"");
        // An int encoded value ranges over its digits.
        s.set_plain(b"n", b"12345").unwrap();
        assert_eq!(&*s.getrange(b"n", 1, 3).expect("a string"), b"234");
        assert_eq!(&*s.getrange(b"n", 9, 9).expect("a string"), b"");
    }

    #[test]
    fn incr_counts_and_refuses_what_is_not_a_number() {
        let mut s = store();
        assert_eq!(s.incr(b"k").unwrap(), 1);
        assert_eq!(s.incr(b"k").unwrap(), 2);
        assert_eq!(s.incrby(b"k", 40).unwrap(), 42);
        assert_eq!(s.decr(b"k").unwrap(), 41);
        assert_eq!(s.decrby(b"k", 41).unwrap(), 0);
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"0"[..]));
        assert_eq!(s.encoding(b"k"), Some(Encoding::Int));

        s.set_plain(b"t", b"hello").unwrap();
        let e = s.incr(b"t").unwrap_err();
        assert_eq!(e.code(), Code::Invalid);
        assert_eq!(e.message(), NOT_AN_INT);
        // The refused increment left the value alone.
        assert_eq!(got(&mut s, b"t").as_deref(), Some(&b"hello"[..]));
    }

    #[test]
    fn incr_works_on_a_number_that_is_stored_as_text() {
        let mut s = store();
        // Appending onto an existing key leaves a raw string, which INCR still
        // counts. Appending onto a key that is not there does not, because
        // Redis runs the new value through tryObjectEncoding on create.
        s.append(b"k", b"1").unwrap();
        assert_eq!(s.encoding(b"k"), Some(Encoding::Int));
        s.append(b"k", b"0").unwrap();
        assert_eq!(s.encoding(b"k"), Some(Encoding::Raw));
        assert_eq!(s.incr(b"k").unwrap(), 11);
        assert_eq!(
            s.encoding(b"k"),
            Some(Encoding::Int),
            "INCR did not re-encode"
        );
        // A leading zero is not a number to string2ll, so it is not one here.
        s.set_plain(b"z", b"007").unwrap();
        assert!(s.incr(b"z").is_err());
    }

    #[test]
    fn a_counter_refuses_to_wrap() {
        let mut s = store();
        s.set_plain(b"k", b"9223372036854775807").unwrap();
        let e = s.incr(b"k").unwrap_err();
        assert_eq!(e.code(), Code::Invalid);
        assert_eq!(e.message(), WOULD_OVERFLOW);
        assert_eq!(
            got(&mut s, b"k").as_deref(),
            Some(&b"9223372036854775807"[..])
        );
        s.set_plain(b"m", b"-9223372036854775808").unwrap();
        assert!(s.decr(b"m").is_err());
        // Subtracting i64::MIN is the case negating first would get wrong.
        s.set_plain(b"d", b"0").unwrap();
        assert!(s.decrby(b"d", i64::MIN).is_err());
    }

    #[test]
    fn incr_keeps_the_deadline_and_reaps_a_dead_key_first() {
        let mut s = store();
        s.set(b"k", b"5", SetOptions::PLAIN.expiring(Expire::At(2_000)))
            .unwrap();
        assert_eq!(s.incr(b"k").unwrap(), 6);
        assert_eq!(s.expire_at(b"k"), Some(2_000), "the deadline was dropped");
        // Past the deadline, the counter starts again from zero and the key has
        // no deadline any more.
        s.clock_mut().set(2_000);
        assert_eq!(s.incr(b"k").unwrap(), 1);
        assert_eq!(s.expire_at(b"k"), None);
        assert_eq!(s.expired_keys(), 1);
    }

    /// The gate is about this path, so it gets its own test: incrementing an int
    /// encoded value must not touch the arena at all.
    #[test]
    fn incr_on_an_int_does_not_allocate() {
        let mut s = store();
        s.set_plain(b"k", b"1").unwrap();
        let before = s.map().arena().live_bytes();
        for want in 2..1_000 {
            assert_eq!(s.incr(b"k").unwrap(), want);
        }
        assert_eq!(
            s.map().arena().live_bytes(),
            before,
            "INCR moved the record"
        );
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"999"[..]));
    }

    #[test]
    fn incrbyfloat_formats_the_way_redis_does() {
        let mut s = store();
        assert_eq!(s.incrbyfloat(b"k", 10.5).unwrap(), 10.5);
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"10.5"[..]));
        assert_eq!(s.incrbyfloat(b"k", 0.1).unwrap(), 10.6);
        // A whole result is still stored as a string, never as an integer.
        s.set_plain(b"n", b"5").unwrap();
        assert_eq!(s.incrbyfloat(b"n", 1.0).unwrap(), 6.0);
        assert_eq!(got(&mut s, b"n").as_deref(), Some(&b"6"[..]));
        assert_eq!(s.encoding(b"n"), Some(Encoding::Embstr));

        s.set_plain(b"t", b"hello").unwrap();
        let e = s.incrbyfloat(b"t", 1.0).unwrap_err();
        assert_eq!(e.message(), NOT_A_FLOAT);
        // An increment that cannot land anywhere is reported as the sum it
        // would have produced, which is the sentence a real server sends and
        // not the one about the argument.
        assert_eq!(
            s.incrbyfloat(b"k", f64::INFINITY).unwrap_err().message(),
            "increment would produce NaN or Infinity"
        );
        assert_eq!(
            s.incrbyfloat(b"k", f64::NAN).unwrap_err().message(),
            "increment would produce NaN or Infinity"
        );
        // And the key it could not increment is left as it was.
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"10.6"[..]));
    }

    /// An int encoded value takes the other arm of the read in `incrbyfloat`,
    /// which converts rather than formatting the digits and parsing them back.
    /// Both arms have to reach the same double or the same command answers two
    /// different things depending on how the value happened to be stored.
    #[test]
    fn incrbyfloat_reads_an_int_encoded_value_the_same_as_its_digits() {
        for n in [0i64, 6, -6, 1 << 40, -(1 << 40), i64::MAX, i64::MIN] {
            let mut s = store();
            s.set_plain(b"i", n.to_string().as_bytes()).unwrap();
            // `APPEND` of nothing leaves the same bytes in a record that is no
            // longer int encoded, which is the only way to get the two arms
            // looking at one value.
            s.set_plain(b"t", n.to_string().as_bytes()).unwrap();
            s.append(b"t", b"").unwrap();
            assert_eq!(s.encoding(b"i"), Some(Encoding::Int));
            assert_ne!(s.encoding(b"t"), Some(Encoding::Int));
            assert_eq!(
                s.incrbyfloat(b"i", 0.5).unwrap(),
                s.incrbyfloat(b"t", 0.5).unwrap(),
                "the two encodings of {n} do not increment alike"
            );
        }
    }

    /// `INCRBYFLOAT` used to copy the value out of the record so it could parse
    /// it, and then throw the copy away.
    #[test]
    fn incrbyfloat_does_not_allocate() {
        let mut s = store();
        for _ in 0..4 {
            s.incrbyfloat(b"f", 1.5).unwrap();
        }
        let (_, allocs) = crate::tally::counted(|| {
            for _ in 0..50 {
                s.incrbyfloat(b"f", 1.5).unwrap();
            }
        });
        assert_eq!(allocs, 0, "incrbyfloat allocated {allocs} times in fifty");
    }

    /// `SET ... GET` used to hand the old value back as a `Vec` that the wire
    /// writes once and drops.
    #[test]
    fn set_with_does_not_allocate_to_report_the_old_value() {
        let mut s = store();
        let opts = SetOptions::PLAIN.returning();
        let mut seen = Vec::with_capacity(64);
        for _ in 0..4 {
            s.set_with(b"k", b"a-value", opts, |v| v.write_to(&mut seen))
                .unwrap();
        }
        let (_, allocs) = crate::tally::counted(|| {
            for _ in 0..50 {
                seen.clear();
                s.set_with(b"k", b"a-value", opts, |v| v.write_to(&mut seen))
                    .unwrap();
            }
        });
        assert_eq!(allocs, 0, "set with GET allocated {allocs} times in fifty");
        assert_eq!(seen, b"a-value");
        // And the owning version still answers what it always did.
        let done = s.set(b"k", b"next", opts).unwrap();
        assert_eq!(done.previous.as_deref(), Some(&b"a-value"[..]));
        assert!(done.stored);
    }

    #[test]
    fn a_value_that_is_too_long_is_an_error_and_not_a_panic() {
        let mut s = store();
        let huge = vec![b'x'; STRING_MAX + 1];
        let e = s.set_plain(b"k", &huge).unwrap_err();
        assert_eq!(e.code(), Code::Full);
        assert_eq!(e.message(), TOO_LONG);
        assert!(s.append(b"k", &huge).is_err());
        assert!(s.setrange(b"k", STRING_MAX, b"x").is_err());
        let long_key = vec![b'k'; KEY_MAX + 1];
        assert_eq!(s.set_plain(&long_key, b"v").unwrap_err().code(), Code::Full);
        assert_eq!(s.len(), 0);
    }

    #[test]
    fn exists_and_strlen_agree_with_get() {
        let mut s = store();
        assert!(!s.exists(b"k"));
        assert_eq!(s.strlen(b"k").expect("a string"), 0);
        s.set(
            b"k",
            b"12345",
            SetOptions::PLAIN.expiring(Expire::At(2_000)),
        )
        .unwrap();
        assert!(s.exists(b"k"));
        assert_eq!(s.strlen(b"k").expect("a string"), 5);
        s.clock_mut().set(2_000);
        assert!(!s.exists(b"k"));
        assert_eq!(s.strlen(b"k").expect("a string"), 0);
    }

    #[test]
    fn msetex_writes_all_of_them_or_none() {
        let mut s = store();
        let pairs = [(&b"a"[..], &b"1"[..]), (&b"b"[..], &b"2"[..])];
        assert!(
            s.msetex(pairs.iter().copied(), Exists::Always, Expire::At(3_000))
                .unwrap()
        );
        assert_eq!(s.expire_at(b"a"), Some(3_000));
        assert_eq!(s.expire_at(b"b"), Some(3_000));

        // The condition is over the whole set. One key present is enough to
        // stop NX, and one key missing is enough to stop XX, and neither
        // writes anything on the way to finding out.
        assert!(
            !s.msetex(pairs.iter().copied(), Exists::IfMissing, Expire::Clear)
                .unwrap()
        );
        assert_eq!(s.expire_at(b"a"), Some(3_000), "a failed NX still wrote");
        s.del(b"b");
        assert!(
            !s.msetex(pairs.iter().copied(), Exists::IfPresent, Expire::Clear)
                .unwrap()
        );
        assert!(!s.exists(b"b"), "a failed XX still wrote");
        assert!(
            s.msetex(pairs.iter().copied(), Exists::IfMissing, Expire::Clear)
                .is_ok()
        );

        // KEEPTTL leaves each key whatever it had, which here is one with a
        // deadline and one without.
        s.set(b"a", b"1", SetOptions::PLAIN.expiring(Expire::At(9_000)))
            .unwrap();
        assert!(
            s.msetex(pairs.iter().copied(), Exists::Always, Expire::Keep)
                .unwrap()
        );
        assert_eq!(s.expire_at(b"a"), Some(9_000));
        assert_eq!(s.expire_at(b"b"), None);
        // With no expiration option at all it clears, the way plain SET does.
        assert!(
            s.msetex(pairs.iter().copied(), Exists::Always, Expire::Clear)
                .unwrap()
        );
        assert_eq!(s.expire_at(b"a"), None);
    }

    #[test]
    fn msetex_lets_the_last_of_a_duplicated_key_win() {
        let mut s = store();
        let pairs = [(&b"k"[..], &b"1"[..]), (&b"k"[..], &b"2"[..])];
        assert!(
            s.msetex(pairs.iter().copied(), Exists::Always, Expire::Clear)
                .unwrap()
        );
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"2"[..]));
    }

    #[test]
    fn delex_deletes_only_what_it_was_told_to() {
        let mut s = store();
        s.set_plain(b"k", b"v").unwrap();
        assert!(!s.delex(b"k", Some(Compare::Equal(b"other"))));
        assert!(s.exists(b"k"), "a failed compare deleted the key");
        assert!(s.delex(b"k", Some(Compare::Equal(b"v"))));
        assert!(!s.exists(b"k"));
        // A key that is not there has nothing to delete, including under the
        // conditions a missing key satisfies.
        assert!(!s.delex(b"k", Some(Compare::Equal(b"v"))));
        assert!(!s.delex(b"k", Some(Compare::NotEqual(b"v"))));
        assert!(!s.delex(b"k", None));
        s.set_plain(b"k", b"v").unwrap();
        assert!(s.delex(b"k", None));
        // Int encoded, so the compare is against the digits.
        s.set_plain(b"n", b"42").unwrap();
        assert!(!s.delex(b"n", Some(Compare::Equal(b"042"))));
        assert!(s.delex(b"n", Some(Compare::Equal(b"42"))));
    }

    #[test]
    fn the_four_conditions_agree_with_a_real_server() {
        let mut s = store();
        // SET IFNE on a key that is not there stores, because a key that is
        // not there is not equal to anything.
        assert!(
            s.set(b"m", b"v", SetOptions::PLAIN.if_not_equal(b"other"))
                .unwrap()
                .stored
        );
        // The digest forms are the value forms with the value hashed.
        let d = s.digest(b"m").expect("a string").expect("just written");
        assert_eq!(d, yo_common::xxh3::hash64(b"v"));
        assert!(
            !s.set(b"m", b"x", SetOptions::PLAIN.if_not_digest(d))
                .unwrap()
                .stored
        );
        assert!(
            s.set(b"m", b"x", SetOptions::PLAIN.if_digest(d))
                .unwrap()
                .stored
        );
        assert_eq!(got(&mut s, b"m").as_deref(), Some(&b"x"[..]));
        assert_eq!(s.digest(b"gone").expect("a string"), None);
        let d = s.digest(b"m").expect("a string").expect("still there");
        assert!(s.delex(b"m", Some(Compare::DigestEqual(d))));
    }

    #[test]
    fn increx_counts_and_leaves_the_deadline_alone() {
        let mut s = store();
        let c = s.increx(b"k", IncrEx::PLAIN).unwrap();
        assert_eq!(
            (c.value, c.applied, c.stored),
            (Num::Int(1), Num::Int(1), true)
        );
        assert_eq!(s.expire_at(b"k"), None, "a plain INCREX set a deadline");
        assert_eq!(s.encoding(b"k"), Some(Encoding::Int));

        // An expiration option sets one, and a later plain call keeps it.
        s.increx(b"k", IncrEx::PLAIN.expiring(IncrExpire::At(2_000)))
            .unwrap();
        assert_eq!(s.expire_at(b"k"), Some(2_000));
        s.increx(b"k", IncrEx::PLAIN).unwrap();
        assert_eq!(s.expire_at(b"k"), Some(2_000));
        // PERSIST drops it.
        s.increx(b"k", IncrEx::PLAIN.expiring(IncrExpire::Persist))
            .unwrap();
        assert_eq!(s.expire_at(b"k"), None);
    }

    #[test]
    fn increx_with_enx_is_the_rate_limiter() {
        let mut s = store();
        // The window starts on the call that found no deadline, and every call
        // inside it leaves the deadline where the first one put it.
        let c = s
            .increx(b"k", IncrEx::PLAIN.expiring(IncrExpire::AtIfNone(1_500)))
            .unwrap();
        assert_eq!(c.value, Num::Int(1));
        assert_eq!(s.expire_at(b"k"), Some(1_500));
        s.clock_mut().set(1_200);
        let c = s
            .increx(b"k", IncrEx::PLAIN.expiring(IncrExpire::AtIfNone(1_700)))
            .unwrap();
        assert_eq!(c.value, Num::Int(2));
        assert_eq!(s.expire_at(b"k"), Some(1_500), "the window was pushed out");
        // Past the deadline the counter and the window both start again.
        s.clock_mut().set(1_500);
        let c = s
            .increx(b"k", IncrEx::PLAIN.expiring(IncrExpire::AtIfNone(2_000)))
            .unwrap();
        assert_eq!(c.value, Num::Int(1));
        assert_eq!(s.expire_at(b"k"), Some(2_000));
        assert_eq!(s.expired_keys(), 1);
    }

    #[test]
    fn a_refused_increx_writes_nothing_at_all() {
        let mut s = store();
        let quota = IncrEx::PLAIN
            .by(Num::Int(10))
            .between(None, Some(Num::Int(5)));
        let c = s.increx(b"k", quota).unwrap();
        assert_eq!(
            (c.value, c.applied, c.stored),
            (Num::Int(0), Num::Int(0), false)
        );
        assert!(!s.exists(b"k"), "a refused increment created the key");

        // The same increment with SATURATE lands on the bound and does create
        // it, which is the difference a client tells by the second number.
        let c = s.increx(b"k", quota.saturating()).unwrap();
        assert_eq!((c.value, c.applied), (Num::Int(5), Num::Int(5)));
        assert!(s.exists(b"k"));

        // A refusal on a key that was already there leaves its deadline alone.
        s.set(b"q", b"1", SetOptions::PLAIN.expiring(Expire::At(4_000)))
            .unwrap();
        let c = s
            .increx(b"q", quota.expiring(IncrExpire::At(9_000)))
            .unwrap();
        assert!(!c.stored);
        assert_eq!(s.expire_at(b"q"), Some(4_000));
        assert_eq!(got(&mut s, b"q").as_deref(), Some(&b"1"[..]));
    }

    #[test]
    fn increx_by_float_stores_text_the_way_incrbyfloat_does() {
        let mut s = store();
        let c = s.increx(b"f", IncrEx::PLAIN.by(Num::Float(1.5))).unwrap();
        assert_eq!((c.value, c.applied), (Num::Float(1.5), Num::Float(1.5)));
        assert_eq!(got(&mut s, b"f").as_deref(), Some(&b"1.5"[..]));
        // An int encoded key counted in floats stops being int encoded, which
        // is what a real server reports afterwards.
        s.set_plain(b"n", b"5").unwrap();
        assert_eq!(s.encoding(b"n"), Some(Encoding::Int));
        s.increx(b"n", IncrEx::PLAIN.by(Num::Float(0.5))).unwrap();
        assert_eq!(s.encoding(b"n"), Some(Encoding::Embstr));
        assert_eq!(got(&mut s, b"n").as_deref(), Some(&b"5.5"[..]));
    }

    #[test]
    fn increx_refuses_a_value_that_is_not_a_number() {
        let mut s = store();
        s.set_plain(b"t", b"hello").unwrap();
        assert!(s.increx(b"t", IncrEx::PLAIN).is_err());
        assert!(s.increx(b"t", IncrEx::PLAIN.by(Num::Float(1.0))).is_err());
    }

    #[test]
    fn lcs_reads_two_keys_and_treats_a_missing_one_as_empty() {
        let mut s = store();
        s.set_plain(b"a", b"ohmytext").unwrap();
        s.set_plain(b"b", b"mynewtext").unwrap();
        assert_eq!(s.lcs(b"a", b"b").unwrap(), b"mytext");
        assert_eq!(s.lcs_len(b"a", b"b").unwrap(), 6);
        assert_eq!(s.lcs_idx(b"a", b"b", 4).unwrap().matches.len(), 1);
        assert_eq!(s.lcs(b"a", b"missing").unwrap(), b"");
        assert_eq!(s.lcs_len(b"missing", b"gone").unwrap(), 0);
        // An int encoded value is compared as its digits.
        s.set_plain(b"n", b"12345").unwrap();
        s.set_plain(b"m", b"13579").unwrap();
        assert_eq!(s.lcs(b"n", b"m").unwrap(), b"135");
    }

    #[test]
    fn lcs_does_not_see_a_key_that_has_expired() {
        let mut s = store();
        s.set(
            b"a",
            b"hello",
            SetOptions::PLAIN.expiring(Expire::At(1_100)),
        )
        .unwrap();
        s.set_plain(b"b", b"hello").unwrap();
        assert_eq!(s.lcs(b"a", b"b").unwrap(), b"hello");
        s.clock_mut().set(1_100);
        assert_eq!(s.lcs(b"a", b"b").unwrap(), b"");
    }

    #[test]
    fn the_store_reports_what_it_is_holding() {
        let mut s = Keyspace::new();
        assert!(s.is_empty());
        assert!(s.memory_bytes() > 0, "an empty index still has buckets");
        s.set_plain(b"k", b"v").unwrap();
        assert!(!s.is_empty());
        assert_eq!(s.len(), 1);
        // The clock is the system one, so it is somewhere after 2020.
        assert!(s.clock().now_ms() > 1_577_836_800_000);
        s.prefetch(Keyspace::hash_of(b"k"));
        assert_eq!(got(&mut s, b"k").as_deref(), Some(&b"v"[..]));
    }

    #[test]
    fn clearing_hands_the_memory_back_and_not_only_the_keys() {
        let mut s = store();
        let empty = s.memory_bytes();
        let big = vec![b'x'; 4_096];
        for i in 0..2_000u32 {
            s.set_plain(format!("k{i}").as_bytes(), &big).unwrap();
        }
        assert_eq!(s.len(), 2_000);
        assert!(s.memory_bytes() > empty * 4, "the store should have grown");

        // One key expires, so the counter has something in it to check.
        s.setex(b"gone", 1, b"v").unwrap();
        s.clock_mut().set(3_000);
        assert!(got(&mut s, b"gone").is_none());
        assert_eq!(s.expired_keys(), 1);

        s.clear();
        assert!(s.is_empty());
        assert_eq!(s.len(), 0);
        assert_eq!(got(&mut s, b"k0"), None);
        // Back to what a fresh store costs, rather than an arena still the size
        // of what used to be in it.
        assert_eq!(s.memory_bytes(), empty);
        // The expiry counter is not reset, because Redis does not reset it
        // either. Emptying a database is not expiring anything.
        assert_eq!(s.expired_keys(), 1);

        // And it still works afterwards.
        s.set_plain(b"after", b"v").unwrap();
        assert_eq!(got(&mut s, b"after").as_deref(), Some(&b"v"[..]));
    }
}