opensearch-dsl 0.3.1

use serde::Serialize;

use crate::{util::*, Query, SpanQuery};

/// Matches spans near the beginning of a field. The span first query maps to
/// Lucene `SpanFirstQuery`. <br/>
/// The `match` clause can be any other span type query. The `end` controls the
/// maximum end position permitted in a match.
///
/// <https://www.elastic.co/guide/en/opensearch/reference/current/query-dsl-span-first-query.html>
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(remote = "Self")]
pub struct SpanFirstQuery {
    r#match: Box<SpanQuery>,
    end: u32,
}

impl Query {
    /// Creates an instance of [`SpanFirstQuery`]
    pub fn span_first<T>(r#match: T, end: u32) -> SpanFirstQuery
    where
        T: Into<SpanQuery>,
    {
        SpanFirstQuery {
            r#match: Box::new(r#match.into()),
            end,
        }
    }
}

impl ShouldSkip for SpanFirstQuery {}

serialize_with_root!("span_first": SpanFirstQuery);
deserialize_with_root!("span_first": SpanFirstQuery);

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serialization() {
        assert_serialize_query(
            Query::span_first(Query::span_term("test", 1234), 10),
            json!({
                "span_first": {
                    "match": {
                        "span_term": {
                            "test": {
                                "value": 1234
                            }
                        }
                    },
                    "end": 10
                }
            }),
        );

        assert_serialize_query(
            Query::span_first(Query::span_term("test", 1234), 10),
            json!({
                "span_first": {
                    "match": {
                        "span_term": {
                            "test": {
                                "value": 1234
                            }
                        }
                    },
                    "end": 10
                }
            }),
        );
    }
}