rustkmer 0.5.2

High-performance k-mer counting tool in Rust
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
//! Query command implementation
//!
//! Implements k-mer querying functionality with support for individual k-mers,
//! multiple k-mers, sequence files, and interactive mode.

use std::io::{self, BufRead, Write};
use std::path::Path;

use crate::cli::args::Args;
use crate::database::{format::DatabaseHeader, DatabaseQuery};
use crate::error::{KmerError, ProcessingResult};
use crate::io::fasta::{validate_fasta_file, FastaProcessor};

/// Execute the query command
pub fn execute_query(args: &Args) -> ProcessingResult<()> {
    match &args.command {
        crate::cli::args::Commands::Query {
            database,
            kmers,
            sequence,
            batch,
            output,
            interactive,
            load,
            no_load,
        } => {
            // Validate input parameters
            if kmers.is_empty() && sequence.is_none() && batch.is_none() && !interactive {
                return Err(KmerError::ProcessingError(
                    "Must specify k-mers, sequence file, batch file, or interactive mode"
                        .to_string(),
                )
                .into());
            }

            // Determine preload strategy
            let preload =
                *load || (!*no_load && (*interactive || sequence.is_some() || batch.is_some()));

            // Open database
            let mut db_query = DatabaseQuery::open(database, preload).map_err(|e| {
                KmerError::ProcessingError(format!("Failed to open database: {}", e))
            })?;

            // Output setup
            let mut writer: Box<dyn Write> = if let Some(output_file) = output {
                let file = std::fs::File::create(output_file).map_err(|e| {
                    KmerError::FileWriteError(format!("Failed to create output file: {}", e))
                })?;
                Box::new(std::io::BufWriter::new(file))
            } else {
                Box::new(std::io::stdout())
            };

            // Handle different query modes
            if *interactive {
                let db_info = db_query.get_info().clone();
                handle_interactive_mode(&mut db_query, &mut writer, &db_info)?;
            } else if let Some(sequence_file) = sequence {
                let db_info = db_query.get_info().clone();
                handle_sequence_query(&mut db_query, &mut writer, sequence_file, &db_info)?;
            } else if let Some(batch_file) = batch {
                let db_info = db_query.get_info().clone();
                handle_batch_query(&mut db_query, &mut writer, batch_file, &db_info)?;
            } else if !kmers.is_empty() {
                let db_info = db_query.get_info().clone();
                handle_kmer_queries(&mut db_query, &mut writer, kmers, &db_info)?;
            }

            Ok(())
        }
        _ => {
            Err(KmerError::ProcessingError("Invalid command for execute_query".to_string()).into())
        }
    }
}

/// Handle individual k-mer queries
fn handle_kmer_queries(
    db_query: &mut DatabaseQuery,
    writer: &mut Box<dyn Write>,
    kmers: &[String],
    db_info: &DatabaseHeader,
) -> ProcessingResult<()> {
    eprintln!(
        "Querying {} k-mers from database (k={})...",
        kmers.len(),
        db_info.kmer_size
    );

    let results = db_query.query_multiple(kmers)?;

    for (kmer, count) in results {
        if count > 0 {
            writeln!(writer, "{}\t{}", kmer, count)
                .map_err(|e| KmerError::FileWriteError(format!("Failed to write result: {}", e)))?;
        } else {
            // Show invalid k-mer error instead of 0 count
            if kmer.len() != db_info.kmer_size as usize {
                writeln!(writer, "Invalid mer '{}'", kmer).map_err(|e| {
                    KmerError::FileWriteError(format!("Failed to write error: {}", e))
                })?;
            }
        }
    }

    eprintln!("Query completed successfully");
    Ok(())
}

/// Handle batch query from file
fn handle_batch_query(
    db_query: &mut DatabaseQuery,
    writer: &mut Box<dyn Write>,
    batch_file: &str,
    _db_info: &DatabaseHeader,
) -> ProcessingResult<()> {
    eprintln!("Querying k-mers from batch file: {}", batch_file);

    // Validate batch file
    let path = Path::new(batch_file);
    if !path.exists() {
        return Err(KmerError::FileNotFound(batch_file.to_string()).into());
    }

    // Read k-mers from file
    let file = std::fs::File::open(path).map_err(|e| KmerError::FileFormatError {
        file: batch_file.to_string(),
        reason: format!("Failed to open batch file: {}", e),
    })?;
    let reader = std::io::BufReader::new(file);

    let mut kmer_list = Vec::new();
    let mut line_num = 0;

    for line in reader.lines() {
        line_num += 1;
        let line = line.map_err(|e| KmerError::FileFormatError {
            file: batch_file.to_string(),
            reason: format!("Error reading line {}: {}", line_num, e),
        })?;
        let trimmed = line.trim();

        // Skip empty lines and comments
        if trimmed.is_empty() || trimmed.starts_with('#') {
            continue;
        }

        // Validate k-mer format
        if !trimmed.chars().all(|c| matches!(c, 'A' | 'T' | 'C' | 'G')) {
            eprintln!(
                "Warning: Invalid k-mer '{}' at line {}, skipping",
                trimmed, line_num
            );
            continue;
        }

        kmer_list.push(trimmed.to_string());
    }

    if kmer_list.is_empty() {
        eprintln!("Warning: No valid k-mers found in batch file");
        return Ok(());
    }

    eprintln!("Loaded {} k-mers from batch file", kmer_list.len());

    // Query k-mers in batches for better performance
    let batch_size = 1000; // Process 1000 k-mers at a time
    let mut total_queries = 0;
    let mut found_kmers = 0;

    for chunk in kmer_list.chunks(batch_size) {
        let results = db_query.query_multiple(chunk)?;

        for (kmer, count) in results {
            total_queries += 1;

            // Always output the k-mer with its count (0 if not found)
            writeln!(writer, "{}\t{}", kmer, count)
                .map_err(|e| KmerError::FileWriteError(format!("Failed to write result: {}", e)))?;

            if count > 0 {
                found_kmers += 1;
            }
        }
    }

    eprintln!(
        "Processed {} k-mers, found {} with non-zero counts",
        total_queries, found_kmers
    );
    Ok(())
}

/// Handle sequence file queries
fn handle_sequence_query(
    db_query: &mut DatabaseQuery,
    writer: &mut Box<dyn Write>,
    sequence_file: &str,
    db_info: &DatabaseHeader,
) -> ProcessingResult<()> {
    eprintln!("Querying k-mers from sequence file: {}", sequence_file);

    // Validate sequence file
    let path = Path::new(sequence_file);
    if !path.exists() {
        return Err(KmerError::FileNotFound(sequence_file.to_string()).into());
    }

    validate_fasta_file(path)?;

    // Process sequence file
    let processor = FastaProcessor::new(path);
    let mut total_queries = 0;
    let mut found_kmers = 0;

    processor.process_file(|record| {
        let sequence = record.seq();

        // Skip sequences shorter than k
        if sequence.len() < db_info.kmer_size as usize {
            return Ok(());
        }

        // Extract all k-mers from sequence
        for i in 0..=(sequence.len() - db_info.kmer_size as usize) {
            let kmer_seq = std::str::from_utf8(&sequence[i..i + db_info.kmer_size as usize])
                .unwrap_or("INVALID");

            total_queries += 1;

            if let Ok(Some(count)) = db_query.query_kmer(kmer_seq) {
                writeln!(writer, "{}\t{}", kmer_seq, count)?;
                if count > 0 {
                    found_kmers += 1;
                }
            } else {
                // Show k-mer with 0 count
                writeln!(writer, "{}\t0", kmer_seq)?;
            }
        }

        Ok(())
    })?;

    eprintln!(
        "Processed {} k-mers, found {} with non-zero counts",
        total_queries, found_kmers
    );
    Ok(())
}

/// Handle interactive query mode
fn handle_interactive_mode(
    db_query: &mut DatabaseQuery,
    writer: &mut Box<dyn Write>,
    db_info: &DatabaseHeader,
) -> ProcessingResult<()> {
    eprintln!("Interactive query mode (k={})", db_info.kmer_size);
    eprintln!("Enter k-mers to query (Ctrl+D to exit):");

    let stdin = io::stdin();
    let lines = stdin.lock().lines();

    for line in lines {
        let line =
            line.map_err(|e| KmerError::ProcessingError(format!("Failed to read input: {}", e)))?;

        let trimmed = line.trim();
        if trimmed.is_empty() {
            continue;
        }

        // Handle multiple k-mers in one line
        let kmer_strings: Vec<&str> = trimmed.split_whitespace().collect();

        for kmer_str in kmer_strings {
            match db_query.query_kmer(kmer_str) {
                Ok(Some(count)) => {
                    writeln!(writer, "{}\t{}", kmer_str, count)?;
                }
                Ok(None) => {
                    if kmer_str.len() != db_info.kmer_size as usize {
                        writeln!(writer, "Invalid mer '{}'", kmer_str)?;
                    } else {
                        writeln!(writer, "{}\t0", kmer_str)?;
                    }
                }
                Err(e) => {
                    writeln!(writer, "Error querying '{}': {}", kmer_str, e)?;
                }
            }
        }
    }

    eprintln!("Interactive mode ended");
    Ok(())
}

/// Validate query parameters
pub fn validate_query_args(args: &Args) -> Result<(), Vec<String>> {
    match &args.command {
        crate::cli::args::Commands::Query {
            database,
            kmers,
            sequence,
            interactive,
            load,
            no_load,
            ..
        } => {
            let mut errors = Vec::new();

            // Check if database file exists
            if !Path::new(database).exists() {
                errors.push(format!("Database file not found: {}", database));
            }

            // Check for contradictory options
            if *load && *no_load {
                errors.push("Cannot specify both --load and --no-load".to_string());
            }

            // Check for conflicting input modes
            if !kmers.is_empty() && sequence.is_some() {
                errors.push("Cannot specify both k-mers and sequence file".to_string());
            }
            if !kmers.is_empty() && *interactive {
                errors.push("Cannot specify both k-mers and interactive mode".to_string());
            }
            if sequence.is_some() && *interactive {
                errors.push("Cannot specify both sequence file and interactive mode".to_string());
            }

            // Validate k-mer sequences if provided
            for (i, kmer) in kmers.iter().enumerate() {
                if kmer.is_empty() {
                    errors.push(format!("Empty k-mer at position {}", i + 1));
                } else if !kmer
                    .chars()
                    .all(|c| matches!(c, 'A' | 'T' | 'G' | 'C' | 'a' | 't' | 'g' | 'c'))
                {
                    errors.push(format!("Invalid characters in k-mer '{}'", kmer));
                }
            }

            if errors.is_empty() {
                Ok(())
            } else {
                Err(errors)
            }
        }
        _ => Ok(()),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cli::args::{Args, Commands};
    use std::io::Write;

    // Helper function to create a temporary database file
    fn create_temp_db() -> tempfile::NamedTempFile {
        let temp_file = tempfile::NamedTempFile::new().unwrap();
        // Write minimal valid content
        let mut file = temp_file.as_file();
        // Write a minimal header (magic + version)
        file.write_all(b"RKDB").unwrap();
        file.write_all(&[1u8; 8]).unwrap(); // placeholder for version and other fields
        temp_file
    }

    #[test]
    fn test_validate_query_args_valid() {
        let temp_db = create_temp_db();
        let args = Args {
            command: Commands::Query {
                database: temp_db.path().to_str().unwrap().to_string(),
                kmers: vec!["ATGCG".to_string()],
                sequence: None,
                output: None,
                interactive: false,
                load: false,
                no_load: false,
                batch: None,
            },
        };

        assert!(validate_query_args(&args).is_ok());
    }

    #[test]
    fn test_validate_query_args_conflicting_options() {
        let temp_db = create_temp_db();
        let args = Args {
            command: Commands::Query {
                database: temp_db.path().to_str().unwrap().to_string(),
                kmers: vec!["ATGCG".to_string()],
                sequence: Some("test.fa".to_string()),
                output: None,
                interactive: false,
                load: false,
                no_load: false,
                batch: None,
            },
        };

        assert!(validate_query_args(&args).is_err());
    }

    #[test]
    fn test_validate_query_args_invalid_kmer() {
        let temp_db = create_temp_db();
        let args = Args {
            command: Commands::Query {
                database: temp_db.path().to_str().unwrap().to_string(),
                kmers: vec!["ATXCG".to_string()], // Invalid character
                sequence: None,
                output: None,
                interactive: false,
                load: false,
                no_load: false,
                batch: None,
            },
        };

        assert!(validate_query_args(&args).is_err());
    }
}